41 lines
6.5 KiB
HTML
41 lines
6.5 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<title>ServerHttpRequest.readBody (handy_http_primitives.request.ServerHttpRequest.readBody)</title>
|
|
<meta charset="utf-8" />
|
|
<meta content="width=device-width, initial-scale=1" name="viewport" />
|
|
<link href="style.css" rel="stylesheet" />
|
|
<script src="script.js" type="text/javascript"></script>
|
|
|
|
|
|
<link href="search-results.html" rel="prefetch" />
|
|
</head>
|
|
<body>
|
|
<div id="page-header">
|
|
<div id="logotype">
|
|
<span>Documentation</span>
|
|
<nav>
|
|
<a href="http://dlang.org/">Dlang.org</a>
|
|
</nav>
|
|
</div>
|
|
|
|
<form action="search-docs.html" id="search">
|
|
<input name="searchTerm" placeholder="Find a symbol name..." type="search" />
|
|
<input type="submit" value="Go" />
|
|
</form>
|
|
</div>
|
|
<div id="page-body">
|
|
<div id="page-content">
|
|
<h1>ServerHttpRequest.readBody</h1><div class="breadcrumbs"><a class="breadcrumb" href="handy_http_primitives.html">handy_http_primitives</a> <a class="breadcrumb" href="handy_http_primitives.request.html">request</a> <a class="breadcrumb" href="handy_http_primitives.request.ServerHttpRequest.html">ServerHttpRequest</a> </div><div><div class="documentation-comment synopsis"><div><p>Reads the body of this request and transfers it to the given output
|
|
stream, limited by the request's "Content-Length" unless you choose to
|
|
allow infinite reading. If the request includes a header for
|
|
"Transfer-Encoding: chunked", then it will wrap the input stream in one
|
|
which decodes HTTP chunked-encoding first.</p></div></div></div><div class="annotated-prototype"><div class="function-prototype"><div class="parent-prototype"><span class="builtin-type">struct</span> <span class="name">ServerHttpRequest</span></div><div><div class="attributes"></div><div class="return-type"><span class="name" data-ident="StreamResult">StreamResult</span></div><div class="function-name">readBody</div><div class="template-parameters" data-count="1">(<div class="parameters-list toplevel"><div class="template-parameter-item parameter-item"> <span><span class="name" data-ident="S">S</span></span></div></div>)</div><div class="runtime-parameters" data-count="2"><div class="parameters-list toplevel"><span class="paren">(</span><div class="runtime-parameter-item parameter-item"><span class="parameter-type-holder"><span class="parameter-type"><span class="storage-class">ref</span> <span class="name" data-ident="S">S</span></span></span> <span class="parameter-name name" data-ident="outputStream"><a href="#param-outputStream">outputStream</a></span></div><span class="comma">,</span><div class="runtime-parameter-item parameter-item"><span class="parameter-type-holder"><span class="parameter-type"><span class="builtin-type">bool</span></span></span> <span class="parameter-name name" data-ident="allowInfiniteRead"><a href="#param-allowInfiniteRead">allowInfiniteRead</a></span><span class="parameter-default-value"> = false</span></div><span class="paren">)</span></div></div><div class="template-constraint"> <a class="lang-feature" href="http://dpldocs.info/template-constraints">if</a> (<div class="template-constraint-expression"><span class="name" data-ident="isByteOutputStream">isByteOutputStream</span>!<span class="name" data-ident="S">S</span></div>)</div><div class="function-contracts"></div></div></div></div><div><h2 id="parameters"><a class="header-anchor" href="#parameters">Parameters</a></h2><dl class="parameter-descriptions"><dt id="param-outputStream"><a class="parameter-name" data-ident="outputStream" href="#param-outputStream">outputStream</a> <span class="parameter-type"><span class="name" data-ident="S">S</span></span></dt><dd><div class="documentation-comment"><div><p>The output stream to transfer data to.</p></div></div></dd><dt id="param-allowInfiniteRead"><a class="parameter-name" data-ident="allowInfiniteRead" href="#param-allowInfiniteRead">allowInfiniteRead</a> <span class="parameter-type"><span class="builtin-type">bool</span></span></dt><dd><div class="documentation-comment"><div><p>Whether to allow reading the request even if the
|
|
Content-Length header is missing or invalid. Use
|
|
with caution!</p></div></div></dd></dl><h2 id="returns"><a class="header-anchor" href="#returns">Return Value</a></h2><div><div class="return-type-holder">Type: <span class="return-type"><span class="name" data-ident="StreamResult">StreamResult</span></span></div><div class="documentation-comment returns-description"><div><p>Either the number of bytes read, or a stream error.</p></div></div></div></div></div>
|
|
<div id="page-nav"><a class="parent" href="handy_http_primitives.html">handy_http_primitives</a> <a class="parent" href="handy_http_primitives.request.html">request</a> <a class="parent" href="handy_http_primitives.request.ServerHttpRequest.html">ServerHttpRequest</a>
|
|
<span class="type-separator">functions</span><ul><li><a class="function" href="handy_http_primitives.request.ServerHttpRequest.getHeaderAs.html">getHeaderAs</a></li><li><a class="function" href="handy_http_primitives.request.ServerHttpRequest.getParamAs.html">getParamAs</a></li><li><a class="function current" href="handy_http_primitives.request.ServerHttpRequest.readBody.html">readBody</a></li><li><a class="function" href="handy_http_primitives.request.ServerHttpRequest.readBodyAsBytes.html">readBodyAsBytes</a></li><li><a class="function" href="handy_http_primitives.request.ServerHttpRequest.readBodyAsString.html">readBodyAsString</a></li></ul><span class="type-separator">variables</span><ul><li><a class="variable" href="handy_http_primitives.request.ServerHttpRequest.clientAddress.html">clientAddress</a></li><li><a class="variable" href="handy_http_primitives.request.ServerHttpRequest.contextData.html">contextData</a></li><li><a class="variable" href="handy_http_primitives.request.ServerHttpRequest.headers.html">headers</a></li><li><a class="variable" href="handy_http_primitives.request.ServerHttpRequest.httpVersion.html">httpVersion</a></li><li><a class="variable" href="handy_http_primitives.request.ServerHttpRequest.inputStream.html">inputStream</a></li><li><a class="variable" href="handy_http_primitives.request.ServerHttpRequest.method.html">method</a></li><li><a class="variable" href="handy_http_primitives.request.ServerHttpRequest.queryParams.html">queryParams</a></li><li><a class="variable" href="handy_http_primitives.request.ServerHttpRequest.url.html">url</a></li></ul></div>
|
|
</div>
|
|
<div id="page-footer">Page generated by <a href="https://github.com/adamdruppe/adrdox">adrdox</a></div>
|
|
</body>
|
|
</html> |