35 lines
14 KiB
HTML
35 lines
14 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<title>ServerHttpRequestBuilder (handy_http_primitives.builder.ServerHttpRequestBuilder)</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>ServerHttpRequestBuilder</h1><div class="breadcrumbs"><a class="breadcrumb" href="handy_http_primitives.html">handy_http_primitives</a> <a class="breadcrumb" href="handy_http_primitives.builder.html">builder</a> </div><div><div class="documentation-comment synopsis"><div><p>Fluent interface for building ServerHttpRequest objects.</p></div></div></div><div class="annotated-prototype"><div class="aggregate-prototype"><div class="attributes"></div><span class="builtin-type">struct</span> ServerHttpRequestBuilder {<div class="aggregate-member"><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.httpVersion.html"><div class="attributes"></div><tt class="highlighted"><span class="hid">HttpVersion</span></tt> <span class="name">httpVersion</span>;</a></div><div class="aggregate-member"><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.clientAddress.html"><div class="attributes"></div><tt class="highlighted"><span class="hid">ClientAddress</span></tt> <span class="name">clientAddress</span>;</a></div><div class="aggregate-member"><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.method.html"><div class="attributes"></div><tt class="highlighted"><span class="type">string</span></tt> <span class="name">method</span>;</a></div><div class="aggregate-member"><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.url.html"><div class="attributes"></div><tt class="highlighted"><span class="type">string</span></tt> <span class="name">url</span>;</a></div><div class="aggregate-member"><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.headers.html"><div class="attributes"></div><tt class="highlighted"><span class="type">string</span>[][<span class="type">string</span>]</tt> <span class="name">headers</span>;</a></div><div class="aggregate-member"><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.queryParams.html"><div class="attributes"></div><tt class="highlighted"><span class="hid">QueryParameter</span>[]</tt> <span class="name">queryParams</span>;</a></div><div class="aggregate-member"><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.inputStream.html"><div class="attributes"></div><tt class="highlighted"><span class="hid">InputStream</span>!<span class="type">ubyte</span></tt> <span class="name">inputStream</span>;</a></div><div class="aggregate-member"><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.contextData.html"><div class="attributes"></div><tt class="highlighted"><span class="hid">Object</span>[<span class="type">string</span>]</tt> <span class="name">contextData</span>;</a></div><div class="aggregate-member"><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.withVersion.html"><span class="lang-feature">ref</span> <span class="name">withVersion</span>(HttpVersion httpVersion);</a></div><div class="aggregate-member"><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.withClientAddress.html"><span class="lang-feature">ref</span> <span class="name">withClientAddress</span>(ClientAddress addr);</a></div><div class="aggregate-member"><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.withMethod.html"><span class="lang-feature">ref</span> <span class="name">withMethod</span>(string method);</a></div><div class="aggregate-member"><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.withUrl.html"><span class="lang-feature">ref</span> <span class="name">withUrl</span>(string url);</a></div><div class="aggregate-member"><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.withHeader.html"><span class="lang-feature">ref</span> <span class="name">withHeader</span>(string headerName, string value);</a></div><div class="aggregate-member"><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.withQueryParam.html"><span class="lang-feature">ref</span> <span class="name">withQueryParam</span>(string paramName, string value);</a></div><div class="aggregate-member"><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.withInputStream.html"><span class="lang-feature">ref</span> <span class="name">withInputStream</span>(S stream);</a></div><div class="aggregate-member"><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.withBody.1.html"><span class="lang-feature">ref</span> <span class="name">withBody</span>(ubyte[] bodyBytes);</a></div><div class="aggregate-member"><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.withBody.2.html"><span class="lang-feature">ref</span> <span class="name">withBody</span>(string bodyStr);</a></div><div class="aggregate-member"><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.withContextData.html"><span class="lang-feature">ref</span> <span class="name">withContextData</span>(string key, Object obj);</a></div><div class="aggregate-member"><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.build.html"><tt class="highlighted"><span class="hid">ServerHttpRequest</span></tt> <span class="name">build</span>();</a></div>}</div></div><h2 id="members"><a class="header-anchor" href="#members">Members</a></h2><h3 class="member-list-header hide-from-toc" id="function"><a class="header-anchor" href="#function">Functions</a></h3><dl class="member-list native"><dt><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.build.html">build</a><div class="simplified-prototype" style="max-width: 27ch;"><tt class="highlighted"><span class="hid">ServerHttpRequest</span></tt> <span class="name">build</span>()</div></dt><dd><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></dd><dt><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.withBody.2.html">withBody</a><div class="simplified-prototype" style="max-width: 31ch;"><span class="lang-feature">ref</span> <span class="name">withBody</span>(string bodyStr)</div></dt><dd><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></dd><dt><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.withBody.1.html">withBody</a><div class="simplified-prototype" style="max-width: 35ch;"><span class="lang-feature">ref</span> <span class="name">withBody</span>(ubyte[] bodyBytes)</div></dt><dd><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></dd><dt><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.withClientAddress.html">withClientAddress</a><div class="simplified-prototype" style="max-width: 46ch;"><span class="lang-feature">ref</span> <span class="name">withClientAddress</span>(ClientAddress addr)</div></dt><dd><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></dd><dt><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.withContextData.html">withContextData</a><div class="simplified-prototype" style="max-width: 48ch;"><span class="lang-feature">ref</span> <span class="name">withContextData</span>(string key, Object obj)</div></dt><dd><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></dd><dt><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.withHeader.html">withHeader</a><div class="simplified-prototype" style="max-width: 52ch;"><span class="lang-feature">ref</span> <span class="name">withHeader</span>(string headerName, string value)</div></dt><dd><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></dd><dt><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.withInputStream.html">withInputStream</a><div class="simplified-prototype" style="max-width: 33ch;"><span class="lang-feature">ref</span> <span class="name">withInputStream</span>(S stream)</div></dt><dd><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></dd><dt><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.withMethod.html">withMethod</a><div class="simplified-prototype" style="max-width: 33ch;"><span class="lang-feature">ref</span> <span class="name">withMethod</span>(string method)</div></dt><dd><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></dd><dt><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.withQueryParam.html">withQueryParam</a><div class="simplified-prototype" style="max-width: 56ch;"><span class="lang-feature">ref</span> <span class="name">withQueryParam</span>(string paramName, string value)</div></dt><dd><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></dd><dt><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.withUrl.html">withUrl</a><div class="simplified-prototype" style="max-width: 26ch;"><span class="lang-feature">ref</span> <span class="name">withUrl</span>(string url)</div></dt><dd><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></dd><dt><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.withVersion.html">withVersion</a><div class="simplified-prototype" style="max-width: 45ch;"><span class="lang-feature">ref</span> <span class="name">withVersion</span>(HttpVersion httpVersion)</div></dt><dd><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></dd></dl><h3 class="member-list-header hide-from-toc" id="variable"><a class="header-anchor" href="#variable">Variables</a></h3><dl class="member-list native"><dt><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.clientAddress.html">clientAddress</a><div class="simplified-prototype" style="max-width: 30ch;"><tt class="highlighted"><span class="hid">ClientAddress</span></tt> <span class="name">clientAddress</span>;</div></dt><dd><div><span class="undocumented-note">Undocumented in source.</span></div></dd><dt><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.contextData.html">contextData</a><div class="simplified-prototype" style="max-width: 29ch;"><tt class="highlighted"><span class="hid">Object</span>[<span class="type">string</span>]</tt> <span class="name">contextData</span>;</div></dt><dd><div><span class="undocumented-note">Undocumented in source.</span></div></dd><dt><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.headers.html">headers</a><div class="simplified-prototype" style="max-width: 27ch;"><tt class="highlighted"><span class="type">string</span>[][<span class="type">string</span>]</tt> <span class="name">headers</span>;</div></dt><dd><div><span class="undocumented-note">Undocumented in source.</span></div></dd><dt><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.httpVersion.html">httpVersion</a><div class="simplified-prototype" style="max-width: 26ch;"><tt class="highlighted"><span class="hid">HttpVersion</span></tt> <span class="name">httpVersion</span>;</div></dt><dd><div><span class="undocumented-note">Undocumented in source.</span></div></dd><dt><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.inputStream.html">inputStream</a><div class="simplified-prototype" style="max-width: 33ch;"><tt class="highlighted"><span class="hid">InputStream</span>!<span class="type">ubyte</span></tt> <span class="name">inputStream</span>;</div></dt><dd><div><span class="undocumented-note">Undocumented in source.</span></div></dd><dt><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.method.html">method</a><div class="simplified-prototype" style="max-width: 15ch;"><tt class="highlighted"><span class="type">string</span></tt> <span class="name">method</span>;</div></dt><dd><div><span class="undocumented-note">Undocumented in source.</span></div></dd><dt><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.queryParams.html">queryParams</a><div class="simplified-prototype" style="max-width: 31ch;"><tt class="highlighted"><span class="hid">QueryParameter</span>[]</tt> <span class="name">queryParams</span>;</div></dt><dd><div><span class="undocumented-note">Undocumented in source.</span></div></dd><dt><a href="handy_http_primitives.builder.ServerHttpRequestBuilder.url.html">url</a><div class="simplified-prototype" style="max-width: 12ch;"><tt class="highlighted"><span class="type">string</span></tt> <span class="name">url</span>;</div></dt><dd><div><span class="undocumented-note">Undocumented in source.</span></div></dd></dl><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.builder.html">builder</a>
|
|
<span class="type-separator">structs</span><ul><li><a class="struct current" href="handy_http_primitives.builder.ServerHttpRequestBuilder.html">ServerHttpRequestBuilder</a></li><li><a class="struct" href="handy_http_primitives.builder.ServerHttpResponseBuilder.html">ServerHttpResponseBuilder</a></li></ul></div>
|
|
</div>
|
|
<div id="page-footer">Page generated by <a href="https://github.com/adamdruppe/adrdox">adrdox</a></div>
|
|
</body>
|
|
</html> |