133 lines
78 KiB
HTML
133 lines
78 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<title>Documentation</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">
|
|
</div>
|
|
<div id="page-nav">
|
|
</div>
|
|
</div>
|
|
<div id="page-footer">Page generated by <a href="https://github.com/adamdruppe/adrdox">adrdox</a></div>
|
|
|
|
<script type="text/xml" id="search-index-container">
|
|
<adrdox>
|
|
<listing>
|
|
<decl id="1" type="module"><name>handy_http_primitives.optional</name><desc><div><p>Module that defines an <tt class="inline-code">Optional</tt> type, which is a simplified version of
|
|
Phobos' Nullable, that also supports mapping the underlying data.</p></div></desc><link>handy_http_primitives.optional.html</link><decl id="2" type="struct"><name>Optional</name><desc><div><p>A simple wrapper around a value to make it optionally present.</p></div></desc><link>handy_http_primitives.optional.Optional.html</link><decl id="3" type="variable"><name>value</name><desc><div><p>The internal value of this optional.</p></div></desc><link>handy_http_primitives.optional.Optional.value.html</link></decl><decl id="4" type="variable"><name>isNull</name><desc><div><p>Whether this optional is empty.</p></div></desc><link>handy_http_primitives.optional.Optional.isNull.html</link></decl><decl id="5" type="static function"><name>of</name><desc><div><p>Constructs an optional value using a given value.</p></div></desc><link>handy_http_primitives.optional.Optional.of.html</link></decl><decl id="6" type="static function"><name>empty</name><desc><div><p>Constructs an optional that's empty.</p></div></desc><link>handy_http_primitives.optional.Optional.empty.html</link></decl><decl id="7" type="function"><name>orElse</name><desc><div><p>Gets the value of this optional if it exists, otherwise uses a given
|
|
default value.</p></div></desc><link>handy_http_primitives.optional.Optional.orElse.html</link></decl><decl id="8" type="function"><name>orElseThrow</name><desc><div><p>Gets the value of this optional if it exists, or throws an exception.</p></div></desc><link>handy_http_primitives.optional.Optional.orElseThrow.1.html</link></decl><decl id="9" type="function"><name>orElseThrow</name><desc><div><p>Gets the value of this optional if it exists, or throws an exception as
|
|
produced by the given delegate.</p></div></desc><link>handy_http_primitives.optional.Optional.orElseThrow.2.html</link></decl><decl id="10" type="function"><name>opCast</name><desc><div><p>Provides a mechanism to allow usage in boolean expressions.</p></div></desc><link>handy_http_primitives.optional.Optional.opCast.html</link></decl></decl><decl id="11" type="function"><name>mapIfPresent</name><desc><div><p>Maps the value of a given optional to another type using a given function.</p></div></desc><link>handy_http_primitives.optional.mapIfPresent.html</link></decl></decl><decl id="12" type="module"><name>handy_http_primitives.request</name><desc><div><p>Defines the request structure and associated types that are generally used
|
|
when dealing with a client's HTTP request.</p></div></desc><link>handy_http_primitives.request.html</link><decl id="13" type="struct"><name>ServerHttpRequest</name><desc><div><p>The HTTP request struct which represents the content of an HTTP request as
|
|
received by a server.</p></div></desc><link>handy_http_primitives.request.ServerHttpRequest.html</link><decl id="14" type="variable"><name>httpVersion</name><desc><div><p>The HTTP version of the request.</p></div></desc><link>handy_http_primitives.request.ServerHttpRequest.httpVersion.html</link></decl><decl id="15" type="variable"><name>clientAddress</name><desc><div><p>The remote address of the client that sent this request.</p></div></desc><link>handy_http_primitives.request.ServerHttpRequest.clientAddress.html</link></decl><decl id="16" type="variable"><name>method</name><desc><div><p>The HTTP verb used in the request.</p></div></desc><link>handy_http_primitives.request.ServerHttpRequest.method.html</link></decl><decl id="17" type="variable"><name>url</name><desc><div><p>The URL that was requested, excluding any query parameters.</p></div></desc><link>handy_http_primitives.request.ServerHttpRequest.url.html</link></decl><decl id="18" type="variable"><name>headers</name><desc><div><p>A case-insensitive map of all request headers.</p></div></desc><link>handy_http_primitives.request.ServerHttpRequest.headers.html</link></decl><decl id="19" type="variable"><name>queryParams</name><desc><div><p>A list of all URL query parameters.</p></div></desc><link>handy_http_primitives.request.ServerHttpRequest.queryParams.html</link></decl><decl id="20" type="variable"><name>inputStream</name><desc><div><p>The underlying stream used to read the body from the request.</p></div></desc><link>handy_http_primitives.request.ServerHttpRequest.inputStream.html</link></decl><decl id="21" type="variable"><name>contextData</name><desc><div><p>Any additional data about this request that may be populated during handling.</p></div></desc><link>handy_http_primitives.request.ServerHttpRequest.contextData.html</link></decl><decl id="22" type="function"><name>getHeaderAs</name><desc><div><p>Gets a header as the specified type, or returns the default value if the
|
|
header doesn't exist or cannot be converted to the desired type.</p></div></desc><link>handy_http_primitives.request.ServerHttpRequest.getHeaderAs.html</link></decl><decl id="23" type="function"><name>getParamAs</name><desc><div><p>Gets a query parameter with a given name, as the specified type, or
|
|
returns the default value if the parameter doesn't exist.</p></div></desc><link>handy_http_primitives.request.ServerHttpRequest.getParamAs.html</link></decl><decl id="24" type="function"><name>readBody</name><desc><div><p>Reads the body of this request and transfers it to the given output
|
|
stream, limited by the request's &quot;Content-Length&quot; unless you choose to
|
|
allow infinite reading. If the request includes a header for
|
|
&quot;Transfer-Encoding: chunked&quot;, then it will wrap the input stream in one
|
|
which decodes HTTP chunked-encoding first.</p></div></desc><link>handy_http_primitives.request.ServerHttpRequest.readBody.html</link></decl><decl id="25" type="function"><name>readBodyAsBytes</name><desc><div><p>Reads the request's body into a new byte array.</p></div></desc><link>handy_http_primitives.request.ServerHttpRequest.readBodyAsBytes.html</link></decl><decl id="26" type="function"><name>readBodyAsString</name><desc><div><p>Reads the request's body into a new string.</p></div></desc><link>handy_http_primitives.request.ServerHttpRequest.readBodyAsString.html</link></decl></decl><decl id="27" type="enum"><name>HttpVersion</name><desc><div><p>Enumeration of all possible HTTP request versions.</p></div></desc><link>handy_http_primitives.request.HttpVersion.html</link></decl><decl id="28" type="enum"><name>HttpMethod</name><desc><div><p>Enumeration of all possible HTTP methods, excluding extensions like WebDAV.</p></div></desc><link>handy_http_primitives.request.HttpMethod.html</link></decl><decl id="29" type="struct"><name>QueryParameter</name><desc><div><p>Stores a single query parameter's key and values.</p></div></desc><link>handy_http_primitives.request.QueryParameter.html</link><decl id="30" type="variable"><name>key</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.request.QueryParameter.key.html</link></decl><decl id="31" type="variable"><name>values</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.request.QueryParameter.values.html</link></decl></decl><decl id="32" type="function"><name>parseQueryParameters</name><desc><div><p>Parses a list of query parameters from a URL.</p></div></desc><link>handy_http_primitives.request.parseQueryParameters.html</link></decl></decl><decl id="33" type="module"><name>handy_http_primitives.handler</name><desc><div><p>Defines the core request handler interface that's the starting point for
|
|
all HTTP request processing.</p></div></desc><link>handy_http_primitives.handler.html</link><decl id="34" type="interface"><name>HttpRequestHandler</name><desc><div><p>Defines the request handler interface, which is called upon to handle an
|
|
incoming HTTP request.</p></div></desc><link>handy_http_primitives.handler.HttpRequestHandler.html</link><decl id="35" type="function"><name>handle</name><desc><div><p>Invoked to handle an incoming HTTP request. Implementations should read
|
|
information from the request, and write to the response.</p></div></desc><link>handy_http_primitives.handler.HttpRequestHandler.handle.html</link></decl><decl id="36" type="static function"><name>of</name><desc><div><p>Gets a request handler that invokes the given function.</p></div></desc><link>handy_http_primitives.handler.HttpRequestHandler.of.1.html</link></decl><decl id="37" type="static function"><name>of</name><desc><div><p>Gets a request handler that invokes the given delegate.</p></div></desc><link>handy_http_primitives.handler.HttpRequestHandler.of.2.html</link></decl></decl></decl><decl id="38" type="module"><name>handy_http_primitives</name><desc><div><p>The handy_http_primitives module defines a set of primitive types and
|
|
interfaces that are shared among all Handy-Http libraries, and form the
|
|
basis of how requests are handled.</p></div></desc><link>handy_http_primitives.html</link><decl id="39" type="module"><name>handy_http_primitives.optional</name><desc><div><p>Module that defines an <tt class="inline-code">Optional</tt> type, which is a simplified version of
|
|
Phobos' Nullable, that also supports mapping the underlying data.</p></div></desc><link>handy_http_primitives.optional.html</link><decl id="40" type="struct"><name>Optional</name><desc><div><p>A simple wrapper around a value to make it optionally present.</p></div></desc><link>handy_http_primitives.optional.Optional.html</link><decl id="41" type="variable"><name>value</name><desc><div><p>The internal value of this optional.</p></div></desc><link>handy_http_primitives.optional.Optional.value.html</link></decl><decl id="42" type="variable"><name>isNull</name><desc><div><p>Whether this optional is empty.</p></div></desc><link>handy_http_primitives.optional.Optional.isNull.html</link></decl><decl id="43" type="static function"><name>of</name><desc><div><p>Constructs an optional value using a given value.</p></div></desc><link>handy_http_primitives.optional.Optional.of.html</link></decl><decl id="44" type="static function"><name>empty</name><desc><div><p>Constructs an optional that's empty.</p></div></desc><link>handy_http_primitives.optional.Optional.empty.html</link></decl><decl id="45" type="function"><name>orElse</name><desc><div><p>Gets the value of this optional if it exists, otherwise uses a given
|
|
default value.</p></div></desc><link>handy_http_primitives.optional.Optional.orElse.html</link></decl><decl id="46" type="function"><name>orElseThrow</name><desc><div><p>Gets the value of this optional if it exists, or throws an exception.</p></div></desc><link>handy_http_primitives.optional.Optional.orElseThrow.1.html</link></decl><decl id="47" type="function"><name>orElseThrow</name><desc><div><p>Gets the value of this optional if it exists, or throws an exception as
|
|
produced by the given delegate.</p></div></desc><link>handy_http_primitives.optional.Optional.orElseThrow.2.html</link></decl><decl id="48" type="function"><name>opCast</name><desc><div><p>Provides a mechanism to allow usage in boolean expressions.</p></div></desc><link>handy_http_primitives.optional.Optional.opCast.html</link></decl></decl><decl id="49" type="function"><name>mapIfPresent</name><desc><div><p>Maps the value of a given optional to another type using a given function.</p></div></desc><link>handy_http_primitives.optional.mapIfPresent.html</link></decl></decl><decl id="50" type="module"><name>handy_http_primitives.request</name><desc><div><p>Defines the request structure and associated types that are generally used
|
|
when dealing with a client's HTTP request.</p></div></desc><link>handy_http_primitives.request.html</link><decl id="51" type="struct"><name>ServerHttpRequest</name><desc><div><p>The HTTP request struct which represents the content of an HTTP request as
|
|
received by a server.</p></div></desc><link>handy_http_primitives.request.ServerHttpRequest.html</link><decl id="52" type="variable"><name>httpVersion</name><desc><div><p>The HTTP version of the request.</p></div></desc><link>handy_http_primitives.request.ServerHttpRequest.httpVersion.html</link></decl><decl id="53" type="variable"><name>clientAddress</name><desc><div><p>The remote address of the client that sent this request.</p></div></desc><link>handy_http_primitives.request.ServerHttpRequest.clientAddress.html</link></decl><decl id="54" type="variable"><name>method</name><desc><div><p>The HTTP verb used in the request.</p></div></desc><link>handy_http_primitives.request.ServerHttpRequest.method.html</link></decl><decl id="55" type="variable"><name>url</name><desc><div><p>The URL that was requested, excluding any query parameters.</p></div></desc><link>handy_http_primitives.request.ServerHttpRequest.url.html</link></decl><decl id="56" type="variable"><name>headers</name><desc><div><p>A case-insensitive map of all request headers.</p></div></desc><link>handy_http_primitives.request.ServerHttpRequest.headers.html</link></decl><decl id="57" type="variable"><name>queryParams</name><desc><div><p>A list of all URL query parameters.</p></div></desc><link>handy_http_primitives.request.ServerHttpRequest.queryParams.html</link></decl><decl id="58" type="variable"><name>inputStream</name><desc><div><p>The underlying stream used to read the body from the request.</p></div></desc><link>handy_http_primitives.request.ServerHttpRequest.inputStream.html</link></decl><decl id="59" type="variable"><name>contextData</name><desc><div><p>Any additional data about this request that may be populated during handling.</p></div></desc><link>handy_http_primitives.request.ServerHttpRequest.contextData.html</link></decl><decl id="60" type="function"><name>getHeaderAs</name><desc><div><p>Gets a header as the specified type, or returns the default value if the
|
|
header doesn't exist or cannot be converted to the desired type.</p></div></desc><link>handy_http_primitives.request.ServerHttpRequest.getHeaderAs.html</link></decl><decl id="61" type="function"><name>getParamAs</name><desc><div><p>Gets a query parameter with a given name, as the specified type, or
|
|
returns the default value if the parameter doesn't exist.</p></div></desc><link>handy_http_primitives.request.ServerHttpRequest.getParamAs.html</link></decl><decl id="62" type="function"><name>readBody</name><desc><div><p>Reads the body of this request and transfers it to the given output
|
|
stream, limited by the request's &quot;Content-Length&quot; unless you choose to
|
|
allow infinite reading. If the request includes a header for
|
|
&quot;Transfer-Encoding: chunked&quot;, then it will wrap the input stream in one
|
|
which decodes HTTP chunked-encoding first.</p></div></desc><link>handy_http_primitives.request.ServerHttpRequest.readBody.html</link></decl><decl id="63" type="function"><name>readBodyAsBytes</name><desc><div><p>Reads the request's body into a new byte array.</p></div></desc><link>handy_http_primitives.request.ServerHttpRequest.readBodyAsBytes.html</link></decl><decl id="64" type="function"><name>readBodyAsString</name><desc><div><p>Reads the request's body into a new string.</p></div></desc><link>handy_http_primitives.request.ServerHttpRequest.readBodyAsString.html</link></decl></decl><decl id="65" type="enum"><name>HttpVersion</name><desc><div><p>Enumeration of all possible HTTP request versions.</p></div></desc><link>handy_http_primitives.request.HttpVersion.html</link></decl><decl id="66" type="enum"><name>HttpMethod</name><desc><div><p>Enumeration of all possible HTTP methods, excluding extensions like WebDAV.</p></div></desc><link>handy_http_primitives.request.HttpMethod.html</link></decl><decl id="67" type="struct"><name>QueryParameter</name><desc><div><p>Stores a single query parameter's key and values.</p></div></desc><link>handy_http_primitives.request.QueryParameter.html</link><decl id="68" type="variable"><name>key</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.request.QueryParameter.key.html</link></decl><decl id="69" type="variable"><name>values</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.request.QueryParameter.values.html</link></decl></decl><decl id="70" type="function"><name>parseQueryParameters</name><desc><div><p>Parses a list of query parameters from a URL.</p></div></desc><link>handy_http_primitives.request.parseQueryParameters.html</link></decl></decl><decl id="71" type="module"><name>handy_http_primitives.handler</name><desc><div><p>Defines the core request handler interface that's the starting point for
|
|
all HTTP request processing.</p></div></desc><link>handy_http_primitives.handler.html</link><decl id="72" type="interface"><name>HttpRequestHandler</name><desc><div><p>Defines the request handler interface, which is called upon to handle an
|
|
incoming HTTP request.</p></div></desc><link>handy_http_primitives.handler.HttpRequestHandler.html</link><decl id="73" type="function"><name>handle</name><desc><div><p>Invoked to handle an incoming HTTP request. Implementations should read
|
|
information from the request, and write to the response.</p></div></desc><link>handy_http_primitives.handler.HttpRequestHandler.handle.html</link></decl><decl id="74" type="static function"><name>of</name><desc><div><p>Gets a request handler that invokes the given function.</p></div></desc><link>handy_http_primitives.handler.HttpRequestHandler.of.1.html</link></decl><decl id="75" type="static function"><name>of</name><desc><div><p>Gets a request handler that invokes the given delegate.</p></div></desc><link>handy_http_primitives.handler.HttpRequestHandler.of.2.html</link></decl></decl></decl><decl id="76" type="module"><name>handy_http_primitives.multivalue_map</name><desc><div><p>An implementation of a multi-valued mapping, where one key may map to one
|
|
or more values.</p></div></desc><link>handy_http_primitives.multivalue_map.html</link><decl id="77" type="struct"><name>MultiValueMap</name><desc><div><p>A multi-valued mapping, where a key is mapped to one or more values. The map
|
|
is sorted by keys for O(log(n)) lookup and retrieval, and O(n*log(n))
|
|
insertion.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.html</link><decl id="78" type="struct"><name>Entry</name><desc><div><p>The internal structure used to store each key and set of values.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.Entry.html</link><decl id="79" type="variable"><name>key</name><desc><div><p>The key for this entry.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.Entry.key.html</link></decl><decl id="80" type="variable"><name>values</name><desc><div><p>The list of values associated with this entry's key. This always
|
|
contains at least one value.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.Entry.values.html</link></decl><decl id="81" type="function"><name>toString</name><desc><div><p>Gets a human-readable string representation of this entry.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.Entry.toString.html</link></decl></decl><decl id="82" type="function"><name>length</name><desc><div><p>Gets the number of unique keys in this map.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.length.html</link></decl><decl id="83" type="function"><name>contains</name><desc><div><p>Determines if this map contains a value for the given key.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.contains.html</link></decl><decl id="84" type="function"><name>keys</name><desc><div><p>Gets a list of all keys in this map, allocated in a new array.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.keys.html</link></decl><decl id="85" type="function"><name>getAll</name><desc><div><p>Gets all values associated with a given key, allocated in a new array.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.getAll.html</link></decl><decl id="86" type="function"><name>getFirst</name><desc><div><p>Gets the first value associated with a given key, as per the order in
|
|
which the values were inserted.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.getFirst.html</link></decl><decl id="87" type="function"><name>add</name><desc><div><p>Adds a single key -&gt; value pair to the map, with time complexity of
|
|
O(n*log(n)) due to sorting the new entry by its key.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.add.html</link></decl><decl id="88" type="function"><name>clear</name><desc><div><p>Clears this map of all values.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.clear.html</link></decl><decl id="89" type="function"><name>remove</name><desc><div><p>Removes a key from the map, thus removing all values associated with
|
|
that key.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.remove.html</link></decl><decl id="90" type="function"><name>asAssociativeArray</name><desc><div><p>Gets this multivalue map as an associative array, where each key is
|
|
mapped to a list of values.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.asAssociativeArray.html</link></decl><decl id="91" type="static function"><name>fromAssociativeArray</name><desc><div><p>Constructs a multivalued map from an associative array.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.fromAssociativeArray.1.html</link></decl><decl id="92" type="static function"><name>fromAssociativeArray</name><desc><div><p>Constructs a multivalued map from an associative array of single values.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.fromAssociativeArray.2.html</link></decl><decl id="93" type="struct"><name>Builder</name><desc><div><p>An efficient builder that can be used to construct a multivalued map
|
|
with successive <tt class="inline-code">add</tt> calls, which is more efficient than doing so
|
|
directly due to the builder's deferred sorting.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.Builder.html</link><decl id="94" type="function"><name>add</name><desc><div><p>Adds a key -&gt; value pair to the builder's map.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.Builder.add.html</link></decl><decl id="95" type="function"><name>build</name><desc><div><p>Builds the multivalued map.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.Builder.build.html</link></decl></decl><decl id="96" type="function"><name>opIndex</name><desc><div><p>Implements the empty index operator, which just returns the entire list
|
|
of entries in this map.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.opIndex.1.html</link></decl><decl id="97" type="function"><name>opIndex</name><desc><div><p>Convenience overload to get the first value for a given key. Note: this
|
|
will throw an exception if no values exist for the given key. To avoid
|
|
this, use <tt class="inline-code">getFirst</tt> and deal with the missing value yourself.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.opIndex.2.html</link></decl><decl id="98" type="function"><name>opApply</name><desc><div><p><tt class="inline-code">opApply</tt> implementation to allow iterating over this map by all pairs
|
|
of keys and values.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.opApply.html</link></decl><decl id="99" type="function"><name>opBinaryRight</name><desc><div><p>Implements opBinaryRight for the &quot;in&quot; operator, such that <tt class="inline-code">k in m</tt> will
|
|
resolve to the list of values for key <tt class="inline-code">k</tt> in the multivalue map <tt class="inline-code">m</tt> if
|
|
that key exists, or <tt class="inline-code">null</tt> if not.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.opBinaryRight.html</link></decl><decl id="100" type="function"><name>toString</name><desc><div><p>Converts this map into a human-readable string which lists each key and
|
|
all of the values for that key.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.toString.html</link></decl></decl><decl id="101" type="alias"><name>StringMultiValueMap</name><desc><div><p>A multivalued map of strings, where each string key refers to zero or more
|
|
string values. All keys are case-sensitive.</p></div></desc><link>handy_http_primitives.multivalue_map.StringMultiValueMap.html</link></decl><decl id="102" type="alias"><name>CaseInsensitiveStringMultiValueMap</name><desc><div><p>A multivalued map of strings, where keys are NOT case sensitive.</p></div></desc><link>handy_http_primitives.multivalue_map.CaseInsensitiveStringMultiValueMap.html</link></decl></decl><decl id="103" type="module"><name>handy_http_primitives.builder</name><desc><div><p>Defines builder types to more easily construct various HTTP objects, often
|
|
useful for testing scenarios.</p></div></desc><link>handy_http_primitives.builder.html</link><decl id="104" type="struct"><name>ServerHttpRequestBuilder</name><desc><div><p>Fluent interface for building ServerHttpRequest objects.</p></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.html</link><decl id="105" type="variable"><name>httpVersion</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.httpVersion.html</link></decl><decl id="106" type="variable"><name>clientAddress</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.clientAddress.html</link></decl><decl id="107" type="variable"><name>method</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.method.html</link></decl><decl id="108" type="variable"><name>url</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.url.html</link></decl><decl id="109" type="variable"><name>headers</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.headers.html</link></decl><decl id="110" type="variable"><name>queryParams</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.queryParams.html</link></decl><decl id="111" type="variable"><name>inputStream</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.inputStream.html</link></decl><decl id="112" type="variable"><name>contextData</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.contextData.html</link></decl><decl id="113" type="function"><name>withVersion</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.withVersion.html</link></decl><decl id="114" type="function"><name>withClientAddress</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.withClientAddress.html</link></decl><decl id="115" type="function"><name>withMethod</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.withMethod.html</link></decl><decl id="116" type="function"><name>withUrl</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.withUrl.html</link></decl><decl id="117" type="function"><name>withHeader</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.withHeader.html</link></decl><decl id="118" type="function"><name>withQueryParam</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.withQueryParam.html</link></decl><decl id="119" type="function"><name>withInputStream</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.withInputStream.html</link></decl><decl id="120" type="function"><name>withBody</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.withBody.1.html</link></decl><decl id="121" type="function"><name>withBody</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.withBody.2.html</link></decl><decl id="122" type="function"><name>withContextData</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.withContextData.html</link></decl><decl id="123" type="function"><name>build</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.build.html</link></decl></decl><decl id="124" type="struct"><name>ServerHttpResponseBuilder</name><desc><div><p>Fluent interface for building ServerHttpResponse objects.</p></div></desc><link>handy_http_primitives.builder.ServerHttpResponseBuilder.html</link><decl id="125" type="variable"><name>initialStatus</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.builder.ServerHttpResponseBuilder.initialStatus.html</link></decl><decl id="126" type="variable"><name>initialHeaders</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.builder.ServerHttpResponseBuilder.initialHeaders.html</link></decl><decl id="127" type="variable"><name>outputStream</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.builder.ServerHttpResponseBuilder.outputStream.html</link></decl><decl id="128" type="function"><name>withStatus</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.builder.ServerHttpResponseBuilder.withStatus.html</link></decl><decl id="129" type="function"><name>withHeader</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.builder.ServerHttpResponseBuilder.withHeader.html</link></decl><decl id="130" type="function"><name>withOutputStream</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.builder.ServerHttpResponseBuilder.withOutputStream.html</link></decl><decl id="131" type="function"><name>build</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.builder.ServerHttpResponseBuilder.build.html</link></decl></decl></decl><decl id="132" type="module"><name>handy_http_primitives.response</name><desc><div><p>Defines the HTTP response structure and associated types that are generally
|
|
used when formulating a response to a client's request.</p></div></desc><link>handy_http_primitives.response.html</link><decl id="133" type="struct"><name>ServerHttpResponse</name><desc><div><p>The response that's sent by a server back to a client after processing the
|
|
client's HTTP request.</p></div></desc><link>handy_http_primitives.response.ServerHttpResponse.html</link><decl id="134" type="variable"><name>status</name><desc><div><p>The response status.</p></div></desc><link>handy_http_primitives.response.ServerHttpResponse.status.html</link></decl><decl id="135" type="variable"><name>headers</name><desc><div><p>A multi-valued map containing all headers.</p></div></desc><link>handy_http_primitives.response.ServerHttpResponse.headers.html</link></decl><decl id="136" type="variable"><name>outputStream</name><desc><div><p>The stream to which the response body is written.</p></div></desc><link>handy_http_primitives.response.ServerHttpResponse.outputStream.html</link></decl><decl id="137" type="function"><name>writeBodyBytes</name><desc><div><p>Writes an array of bytes to the response's output stream.</p></div></desc><link>handy_http_primitives.response.ServerHttpResponse.writeBodyBytes.html</link></decl><decl id="138" type="function"><name>writeBodyString</name><desc><div><p>Writes a string of content to the response's output stream.</p></div></desc><link>handy_http_primitives.response.ServerHttpResponse.writeBodyString.html</link></decl></decl><decl id="139" type="struct"><name>StatusInfo</name><desc><div><p>A struct containing basic information about a response status.</p></div></desc><link>handy_http_primitives.response.StatusInfo.html</link><decl id="140" type="variable"><name>code</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.response.StatusInfo.code.html</link></decl><decl id="141" type="variable"><name>text</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.response.StatusInfo.text.html</link></decl></decl><decl id="142" type="enum"><name>HttpStatus</name><desc><div><p>An enum defining all valid HTTP response statuses:
|
|
See here: <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status">https://developer.mozilla.org/en-US/docs/Web/HTTP/Status</a></p></div></desc><link>handy_http_primitives.response.HttpStatus.html</link></decl><decl id="143" type="enum"><name>ContentTypes</name><desc><div><p>Common &quot;Content-Type&quot; header values.</p></div></desc><link>handy_http_primitives.response.ContentTypes.html</link></decl><decl id="144" type="class"><name>HttpStatusException</name><desc><div><p>An exception that can be thrown while handling an HTTP request, to indicate
|
|
that the server should return a specified response code, usually when you
|
|
want to short-circuit due to an error.</p></div></desc><link>handy_http_primitives.response.HttpStatusException.html</link><decl id="145" type="variable"><name>status</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.response.HttpStatusException.status.html</link></decl><decl id="146" type="constructor"><name>this</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.response.HttpStatusException.this.1.html</link></decl><decl id="147" type="constructor"><name>this</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.response.HttpStatusException.this.2.html</link></decl><decl id="148" type="constructor"><name>this</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.response.HttpStatusException.this.3.html</link></decl></decl></decl><decl id="149" type="module"><name>handy_http_primitives.testing</name><desc><div><p>The testing module defines helper methods for testing your HTTP handling
|
|
code.</p></div></desc><link>handy_http_primitives.testing.html</link><decl id="150" type="function"><name>assertStatus</name><desc><div><p>Asserts that the given response's status matches an expected status.</p></div></desc><link>handy_http_primitives.testing.assertStatus.html</link></decl><decl id="151" type="function"><name>assertStatusOk</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.testing.assertStatusOk.html</link></decl><decl id="152" type="function"><name>assertStatusNotFound</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.testing.assertStatusNotFound.html</link></decl><decl id="153" type="function"><name>assertStatusBadRequest</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.testing.assertStatusBadRequest.html</link></decl><decl id="154" type="function"><name>assertStatusUnauthorized</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.testing.assertStatusUnauthorized.html</link></decl><decl id="155" type="function"><name>assertStatusForbidden</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.testing.assertStatusForbidden.html</link></decl><decl id="156" type="function"><name>assertStatusInternalServerError</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.testing.assertStatusInternalServerError.html</link></decl><decl id="157" type="function"><name>assertHasHeader</name><desc><div><p>Asserts that the given response has a header with a given value.</p></div></desc><link>handy_http_primitives.testing.assertHasHeader.html</link></decl></decl><decl id="158" type="module"><name>handy_http_primitives.address</name><desc><div><p>Defines various address types for use with HTTP communication.</p></div></desc><link>handy_http_primitives.address.html</link><decl id="159" type="struct"><name>IPv4InternetAddress</name><desc><div><p>Represents a 4-byte IPv4 network address and the port number on this machine
|
|
that the connection was assigned to.</p></div></desc><link>handy_http_primitives.address.IPv4InternetAddress.html</link><decl id="160" type="variable"><name>bytes</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.address.IPv4InternetAddress.bytes.html</link></decl><decl id="161" type="variable"><name>port</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.address.IPv4InternetAddress.port.html</link></decl></decl><decl id="162" type="struct"><name>IPv6InternetAddress</name><desc><div><p>Represents a 16-byte IPv6 network address and the port number on this
|
|
machine that the connection was assigned to.</p></div></desc><link>handy_http_primitives.address.IPv6InternetAddress.html</link><decl id="163" type="variable"><name>bytes</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.address.IPv6InternetAddress.bytes.html</link></decl><decl id="164" type="variable"><name>port</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.address.IPv6InternetAddress.port.html</link></decl></decl><decl id="165" type="struct"><name>UnixSocketAddress</name><desc><div><p>Represents a unix socket address, which is just a path to a file at which
|
|
IO operations take place.</p></div></desc><link>handy_http_primitives.address.UnixSocketAddress.html</link><decl id="166" type="variable"><name>path</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.address.UnixSocketAddress.path.html</link></decl></decl><decl id="167" type="enum"><name>ClientAddressType</name><desc><div><p>Defines the different possible address types, used by <tt class="inline-code">ClientAddress</tt>.</p></div></desc><link>handy_http_primitives.address.ClientAddressType.html</link></decl><decl id="168" type="struct"><name>ClientAddress</name><desc><div><p>A compound type representing the address of any entity sending an HTTP
|
|
request. Use <tt class="inline-code">type</tt> to determine which information is available.</p></div></desc><link>handy_http_primitives.address.ClientAddress.html</link><decl id="169" type="variable"><name>type</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.address.ClientAddress.type.html</link></decl><decl id="170" type="variable"><name>ipv4InternetAddress</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.address.ClientAddress.ipv4InternetAddress.html</link></decl><decl id="171" type="variable"><name>ipv6InternetAddress</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.address.ClientAddress.ipv6InternetAddress.html</link></decl><decl id="172" type="variable"><name>unixSocketAddress</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.address.ClientAddress.unixSocketAddress.html</link></decl><decl id="173" type="function"><name>toString</name><desc><div><p>Serializes this address in a human-readable string representation.</p></div></desc><link>handy_http_primitives.address.ClientAddress.toString.html</link></decl><decl id="174" type="static function"><name>ofIPv4</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.address.ClientAddress.ofIPv4.html</link></decl><decl id="175" type="static function"><name>ofIPv6</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.address.ClientAddress.ofIPv6.html</link></decl><decl id="176" type="static function"><name>ofUnixSocket</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.address.ClientAddress.ofUnixSocket.html</link></decl><decl id="177" type="static function"><name>unknown</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.address.ClientAddress.unknown.html</link></decl></decl></decl></decl><decl id="178" type="module"><name>handy_http_primitives.multivalue_map</name><desc><div><p>An implementation of a multi-valued mapping, where one key may map to one
|
|
or more values.</p></div></desc><link>handy_http_primitives.multivalue_map.html</link><decl id="179" type="struct"><name>MultiValueMap</name><desc><div><p>A multi-valued mapping, where a key is mapped to one or more values. The map
|
|
is sorted by keys for O(log(n)) lookup and retrieval, and O(n*log(n))
|
|
insertion.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.html</link><decl id="180" type="struct"><name>Entry</name><desc><div><p>The internal structure used to store each key and set of values.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.Entry.html</link><decl id="181" type="variable"><name>key</name><desc><div><p>The key for this entry.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.Entry.key.html</link></decl><decl id="182" type="variable"><name>values</name><desc><div><p>The list of values associated with this entry's key. This always
|
|
contains at least one value.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.Entry.values.html</link></decl><decl id="183" type="function"><name>toString</name><desc><div><p>Gets a human-readable string representation of this entry.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.Entry.toString.html</link></decl></decl><decl id="184" type="function"><name>length</name><desc><div><p>Gets the number of unique keys in this map.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.length.html</link></decl><decl id="185" type="function"><name>contains</name><desc><div><p>Determines if this map contains a value for the given key.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.contains.html</link></decl><decl id="186" type="function"><name>keys</name><desc><div><p>Gets a list of all keys in this map, allocated in a new array.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.keys.html</link></decl><decl id="187" type="function"><name>getAll</name><desc><div><p>Gets all values associated with a given key, allocated in a new array.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.getAll.html</link></decl><decl id="188" type="function"><name>getFirst</name><desc><div><p>Gets the first value associated with a given key, as per the order in
|
|
which the values were inserted.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.getFirst.html</link></decl><decl id="189" type="function"><name>add</name><desc><div><p>Adds a single key -&gt; value pair to the map, with time complexity of
|
|
O(n*log(n)) due to sorting the new entry by its key.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.add.html</link></decl><decl id="190" type="function"><name>clear</name><desc><div><p>Clears this map of all values.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.clear.html</link></decl><decl id="191" type="function"><name>remove</name><desc><div><p>Removes a key from the map, thus removing all values associated with
|
|
that key.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.remove.html</link></decl><decl id="192" type="function"><name>asAssociativeArray</name><desc><div><p>Gets this multivalue map as an associative array, where each key is
|
|
mapped to a list of values.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.asAssociativeArray.html</link></decl><decl id="193" type="static function"><name>fromAssociativeArray</name><desc><div><p>Constructs a multivalued map from an associative array.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.fromAssociativeArray.1.html</link></decl><decl id="194" type="static function"><name>fromAssociativeArray</name><desc><div><p>Constructs a multivalued map from an associative array of single values.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.fromAssociativeArray.2.html</link></decl><decl id="195" type="struct"><name>Builder</name><desc><div><p>An efficient builder that can be used to construct a multivalued map
|
|
with successive <tt class="inline-code">add</tt> calls, which is more efficient than doing so
|
|
directly due to the builder's deferred sorting.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.Builder.html</link><decl id="196" type="function"><name>add</name><desc><div><p>Adds a key -&gt; value pair to the builder's map.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.Builder.add.html</link></decl><decl id="197" type="function"><name>build</name><desc><div><p>Builds the multivalued map.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.Builder.build.html</link></decl></decl><decl id="198" type="function"><name>opIndex</name><desc><div><p>Implements the empty index operator, which just returns the entire list
|
|
of entries in this map.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.opIndex.1.html</link></decl><decl id="199" type="function"><name>opIndex</name><desc><div><p>Convenience overload to get the first value for a given key. Note: this
|
|
will throw an exception if no values exist for the given key. To avoid
|
|
this, use <tt class="inline-code">getFirst</tt> and deal with the missing value yourself.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.opIndex.2.html</link></decl><decl id="200" type="function"><name>opApply</name><desc><div><p><tt class="inline-code">opApply</tt> implementation to allow iterating over this map by all pairs
|
|
of keys and values.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.opApply.html</link></decl><decl id="201" type="function"><name>opBinaryRight</name><desc><div><p>Implements opBinaryRight for the &quot;in&quot; operator, such that <tt class="inline-code">k in m</tt> will
|
|
resolve to the list of values for key <tt class="inline-code">k</tt> in the multivalue map <tt class="inline-code">m</tt> if
|
|
that key exists, or <tt class="inline-code">null</tt> if not.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.opBinaryRight.html</link></decl><decl id="202" type="function"><name>toString</name><desc><div><p>Converts this map into a human-readable string which lists each key and
|
|
all of the values for that key.</p></div></desc><link>handy_http_primitives.multivalue_map.MultiValueMap.toString.html</link></decl></decl><decl id="203" type="alias"><name>StringMultiValueMap</name><desc><div><p>A multivalued map of strings, where each string key refers to zero or more
|
|
string values. All keys are case-sensitive.</p></div></desc><link>handy_http_primitives.multivalue_map.StringMultiValueMap.html</link></decl><decl id="204" type="alias"><name>CaseInsensitiveStringMultiValueMap</name><desc><div><p>A multivalued map of strings, where keys are NOT case sensitive.</p></div></desc><link>handy_http_primitives.multivalue_map.CaseInsensitiveStringMultiValueMap.html</link></decl></decl><decl id="205" type="module"><name>handy_http_primitives.builder</name><desc><div><p>Defines builder types to more easily construct various HTTP objects, often
|
|
useful for testing scenarios.</p></div></desc><link>handy_http_primitives.builder.html</link><decl id="206" type="struct"><name>ServerHttpRequestBuilder</name><desc><div><p>Fluent interface for building ServerHttpRequest objects.</p></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.html</link><decl id="207" type="variable"><name>httpVersion</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.httpVersion.html</link></decl><decl id="208" type="variable"><name>clientAddress</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.clientAddress.html</link></decl><decl id="209" type="variable"><name>method</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.method.html</link></decl><decl id="210" type="variable"><name>url</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.url.html</link></decl><decl id="211" type="variable"><name>headers</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.headers.html</link></decl><decl id="212" type="variable"><name>queryParams</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.queryParams.html</link></decl><decl id="213" type="variable"><name>inputStream</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.inputStream.html</link></decl><decl id="214" type="variable"><name>contextData</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.contextData.html</link></decl><decl id="215" type="function"><name>withVersion</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.withVersion.html</link></decl><decl id="216" type="function"><name>withClientAddress</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.withClientAddress.html</link></decl><decl id="217" type="function"><name>withMethod</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.withMethod.html</link></decl><decl id="218" type="function"><name>withUrl</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.withUrl.html</link></decl><decl id="219" type="function"><name>withHeader</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.withHeader.html</link></decl><decl id="220" type="function"><name>withQueryParam</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.withQueryParam.html</link></decl><decl id="221" type="function"><name>withInputStream</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.withInputStream.html</link></decl><decl id="222" type="function"><name>withBody</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.withBody.1.html</link></decl><decl id="223" type="function"><name>withBody</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.withBody.2.html</link></decl><decl id="224" type="function"><name>withContextData</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.withContextData.html</link></decl><decl id="225" type="function"><name>build</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.builder.ServerHttpRequestBuilder.build.html</link></decl></decl><decl id="226" type="struct"><name>ServerHttpResponseBuilder</name><desc><div><p>Fluent interface for building ServerHttpResponse objects.</p></div></desc><link>handy_http_primitives.builder.ServerHttpResponseBuilder.html</link><decl id="227" type="variable"><name>initialStatus</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.builder.ServerHttpResponseBuilder.initialStatus.html</link></decl><decl id="228" type="variable"><name>initialHeaders</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.builder.ServerHttpResponseBuilder.initialHeaders.html</link></decl><decl id="229" type="variable"><name>outputStream</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.builder.ServerHttpResponseBuilder.outputStream.html</link></decl><decl id="230" type="function"><name>withStatus</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.builder.ServerHttpResponseBuilder.withStatus.html</link></decl><decl id="231" type="function"><name>withHeader</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.builder.ServerHttpResponseBuilder.withHeader.html</link></decl><decl id="232" type="function"><name>withOutputStream</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.builder.ServerHttpResponseBuilder.withOutputStream.html</link></decl><decl id="233" type="function"><name>build</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.builder.ServerHttpResponseBuilder.build.html</link></decl></decl></decl><decl id="234" type="module"><name>handy_http_primitives.response</name><desc><div><p>Defines the HTTP response structure and associated types that are generally
|
|
used when formulating a response to a client's request.</p></div></desc><link>handy_http_primitives.response.html</link><decl id="235" type="struct"><name>ServerHttpResponse</name><desc><div><p>The response that's sent by a server back to a client after processing the
|
|
client's HTTP request.</p></div></desc><link>handy_http_primitives.response.ServerHttpResponse.html</link><decl id="236" type="variable"><name>status</name><desc><div><p>The response status.</p></div></desc><link>handy_http_primitives.response.ServerHttpResponse.status.html</link></decl><decl id="237" type="variable"><name>headers</name><desc><div><p>A multi-valued map containing all headers.</p></div></desc><link>handy_http_primitives.response.ServerHttpResponse.headers.html</link></decl><decl id="238" type="variable"><name>outputStream</name><desc><div><p>The stream to which the response body is written.</p></div></desc><link>handy_http_primitives.response.ServerHttpResponse.outputStream.html</link></decl><decl id="239" type="function"><name>writeBodyBytes</name><desc><div><p>Writes an array of bytes to the response's output stream.</p></div></desc><link>handy_http_primitives.response.ServerHttpResponse.writeBodyBytes.html</link></decl><decl id="240" type="function"><name>writeBodyString</name><desc><div><p>Writes a string of content to the response's output stream.</p></div></desc><link>handy_http_primitives.response.ServerHttpResponse.writeBodyString.html</link></decl></decl><decl id="241" type="struct"><name>StatusInfo</name><desc><div><p>A struct containing basic information about a response status.</p></div></desc><link>handy_http_primitives.response.StatusInfo.html</link><decl id="242" type="variable"><name>code</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.response.StatusInfo.code.html</link></decl><decl id="243" type="variable"><name>text</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.response.StatusInfo.text.html</link></decl></decl><decl id="244" type="enum"><name>HttpStatus</name><desc><div><p>An enum defining all valid HTTP response statuses:
|
|
See here: <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status">https://developer.mozilla.org/en-US/docs/Web/HTTP/Status</a></p></div></desc><link>handy_http_primitives.response.HttpStatus.html</link></decl><decl id="245" type="enum"><name>ContentTypes</name><desc><div><p>Common &quot;Content-Type&quot; header values.</p></div></desc><link>handy_http_primitives.response.ContentTypes.html</link></decl><decl id="246" type="class"><name>HttpStatusException</name><desc><div><p>An exception that can be thrown while handling an HTTP request, to indicate
|
|
that the server should return a specified response code, usually when you
|
|
want to short-circuit due to an error.</p></div></desc><link>handy_http_primitives.response.HttpStatusException.html</link><decl id="247" type="variable"><name>status</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.response.HttpStatusException.status.html</link></decl><decl id="248" type="constructor"><name>this</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.response.HttpStatusException.this.1.html</link></decl><decl id="249" type="constructor"><name>this</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.response.HttpStatusException.this.2.html</link></decl><decl id="250" type="constructor"><name>this</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.response.HttpStatusException.this.3.html</link></decl></decl></decl><decl id="251" type="module"><name>handy_http_primitives.testing</name><desc><div><p>The testing module defines helper methods for testing your HTTP handling
|
|
code.</p></div></desc><link>handy_http_primitives.testing.html</link><decl id="252" type="function"><name>assertStatus</name><desc><div><p>Asserts that the given response's status matches an expected status.</p></div></desc><link>handy_http_primitives.testing.assertStatus.html</link></decl><decl id="253" type="function"><name>assertStatusOk</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.testing.assertStatusOk.html</link></decl><decl id="254" type="function"><name>assertStatusNotFound</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.testing.assertStatusNotFound.html</link></decl><decl id="255" type="function"><name>assertStatusBadRequest</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.testing.assertStatusBadRequest.html</link></decl><decl id="256" type="function"><name>assertStatusUnauthorized</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.testing.assertStatusUnauthorized.html</link></decl><decl id="257" type="function"><name>assertStatusForbidden</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.testing.assertStatusForbidden.html</link></decl><decl id="258" type="function"><name>assertStatusInternalServerError</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.testing.assertStatusInternalServerError.html</link></decl><decl id="259" type="function"><name>assertHasHeader</name><desc><div><p>Asserts that the given response has a header with a given value.</p></div></desc><link>handy_http_primitives.testing.assertHasHeader.html</link></decl></decl><decl id="260" type="module"><name>handy_http_primitives.address</name><desc><div><p>Defines various address types for use with HTTP communication.</p></div></desc><link>handy_http_primitives.address.html</link><decl id="261" type="struct"><name>IPv4InternetAddress</name><desc><div><p>Represents a 4-byte IPv4 network address and the port number on this machine
|
|
that the connection was assigned to.</p></div></desc><link>handy_http_primitives.address.IPv4InternetAddress.html</link><decl id="262" type="variable"><name>bytes</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.address.IPv4InternetAddress.bytes.html</link></decl><decl id="263" type="variable"><name>port</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.address.IPv4InternetAddress.port.html</link></decl></decl><decl id="264" type="struct"><name>IPv6InternetAddress</name><desc><div><p>Represents a 16-byte IPv6 network address and the port number on this
|
|
machine that the connection was assigned to.</p></div></desc><link>handy_http_primitives.address.IPv6InternetAddress.html</link><decl id="265" type="variable"><name>bytes</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.address.IPv6InternetAddress.bytes.html</link></decl><decl id="266" type="variable"><name>port</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.address.IPv6InternetAddress.port.html</link></decl></decl><decl id="267" type="struct"><name>UnixSocketAddress</name><desc><div><p>Represents a unix socket address, which is just a path to a file at which
|
|
IO operations take place.</p></div></desc><link>handy_http_primitives.address.UnixSocketAddress.html</link><decl id="268" type="variable"><name>path</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.address.UnixSocketAddress.path.html</link></decl></decl><decl id="269" type="enum"><name>ClientAddressType</name><desc><div><p>Defines the different possible address types, used by <tt class="inline-code">ClientAddress</tt>.</p></div></desc><link>handy_http_primitives.address.ClientAddressType.html</link></decl><decl id="270" type="struct"><name>ClientAddress</name><desc><div><p>A compound type representing the address of any entity sending an HTTP
|
|
request. Use <tt class="inline-code">type</tt> to determine which information is available.</p></div></desc><link>handy_http_primitives.address.ClientAddress.html</link><decl id="271" type="variable"><name>type</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.address.ClientAddress.type.html</link></decl><decl id="272" type="variable"><name>ipv4InternetAddress</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.address.ClientAddress.ipv4InternetAddress.html</link></decl><decl id="273" type="variable"><name>ipv6InternetAddress</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.address.ClientAddress.ipv6InternetAddress.html</link></decl><decl id="274" type="variable"><name>unixSocketAddress</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_primitives.address.ClientAddress.unixSocketAddress.html</link></decl><decl id="275" type="function"><name>toString</name><desc><div><p>Serializes this address in a human-readable string representation.</p></div></desc><link>handy_http_primitives.address.ClientAddress.toString.html</link></decl><decl id="276" type="static function"><name>ofIPv4</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.address.ClientAddress.ofIPv4.html</link></decl><decl id="277" type="static function"><name>ofIPv6</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.address.ClientAddress.ofIPv6.html</link></decl><decl id="278" type="static function"><name>ofUnixSocket</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.address.ClientAddress.ofUnixSocket.html</link></decl><decl id="279" type="static function"><name>unknown</name><desc><div><span class="undocumented-note">Undocumented in source. Be warned that the author may not have intended to support it.</span></div></desc><link>handy_http_primitives.address.ClientAddress.unknown.html</link></decl></decl></decl></listing>
|
|
<index>
|
|
</index>
|
|
</adrdox>
|
|
</script>
|
|
<script src="search-docs.js"></script>
|
|
</body></html>
|