83 lines
13 KiB
HTML
83 lines
13 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_data.json</name><desc><div><p>Defines functions to read and write JSON values when handling HTTP requests.</p></div></desc><link>handy_http_data.json.html</link><decl id="2" type="function"><name>readJsonBodyAs</name><desc><div><p>Reads a JSON value from the body of the given HTTP request, parsing it using
|
|
the ASDF library according to the template type T.</p></div></desc><link>handy_http_data.json.readJsonBodyAs.html</link></decl><decl id="3" type="function"><name>writeJsonBody</name><desc><div><p>Writes a JSON value to the body of the given HTTP response, serializing it
|
|
using the ASDF library. Will also set Content-Type and Content-Length
|
|
headers before writing.</p></div></desc><link>handy_http_data.json.writeJsonBody.html</link></decl></decl><decl id="4" type="module"><name>handy_http_data.multipart</name><desc><div><p>Defines data structures and parsing methods for dealing with multipart
|
|
encoded request bodies.</p></div></desc><link>handy_http_data.multipart.html</link><decl id="5" type="struct"><name>MultipartElement</name><desc><div><p>A single element that's part of a multipart/form-data body.</p></div></desc><link>handy_http_data.multipart.MultipartElement.html</link><decl id="6" type="variable"><name>name</name><desc><div><p>The name of this element, as declared by this part's Content-Disposition
|
|
header <tt class="inline-code">name</tt> property. There is no guarantee that this name is unique
|
|
among all elements.</p></div></desc><link>handy_http_data.multipart.MultipartElement.name.html</link></decl><decl id="7" type="variable"><name>filename</name><desc><div><p>The filename of this element, as declared by this part's
|
|
Content-Disposition header <tt class="inline-code">filename</tt> property. Note that this may be
|
|
null if no filename exists.</p></div></desc><link>handy_http_data.multipart.MultipartElement.filename.html</link></decl><decl id="8" type="variable"><name>headers</name><desc><div><p>The headers that were present with this element.</p></div></desc><link>handy_http_data.multipart.MultipartElement.headers.html</link></decl><decl id="9" type="variable"><name>content</name><desc><div><p>The body content of this element.</p></div></desc><link>handy_http_data.multipart.MultipartElement.content.html</link></decl></decl><decl id="10" type="struct"><name>MultipartFormData</name><desc><div><p>A multipart/form-data body containing multiple elements, and some helper
|
|
methods for those elements.</p></div></desc><link>handy_http_data.multipart.MultipartFormData.html</link><decl id="11" type="variable"><name>elements</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_data.multipart.MultipartFormData.elements.html</link></decl><decl id="12" type="function"><name>has</name><desc><div><p>Determines if this form-data has an element with the given name. This
|
|
is case-sensitive. Note that there may be more than one element with a
|
|
given name.</p></div></desc><link>handy_http_data.multipart.MultipartFormData.has.html</link></decl></decl><decl id="13" type="class"><name>MultipartFormatException</name><desc><div><p>An exception that's thrown if parsing multipart/form-data fails due to
|
|
invalid formatting or unexpected characters. This is a sub-class of the
|
|
<tt class="inline-code">HttpStatusException</tt>, with each multipart exception being a BAD_REQUEST.</p></div></desc><link>handy_http_data.multipart.MultipartFormatException.html</link><decl id="14" type="constructor"><name>this</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_data.multipart.MultipartFormatException.this.html</link></decl></decl><decl id="15" type="variable"><name>MAX_ELEMENTS</name><desc><div><p>The maximum number of parts to read in a multipart/form-data body. This is
|
|
declared as a safety measure to avoid infinite reading of malicious or
|
|
corrupted payloads.</p></div></desc><link>handy_http_data.multipart.MAX_ELEMENTS.html</link></decl><decl id="16" type="function"><name>readBodyAsMultipartFormData</name><desc><div><p>Reads a request's body as multipart/form-data encoded elements.</p></div></desc><link>handy_http_data.multipart.readBodyAsMultipartFormData.html</link></decl><decl id="17" type="function"><name>parseMultipartFormData</name><desc><div><p>A simple linear parser for multipart/form-data encoded content. Reads a
|
|
series of elements separated by a given boundary. An exception is thrown
|
|
if the given content doesn't conform to standard multipart format.</p></div></desc><link>handy_http_data.multipart.parseMultipartFormData.html</link></decl></decl><decl id="18" type="module"><name>handy_http_data</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_data.html</link><decl id="19" type="module"><name>handy_http_data.json</name><desc><div><p>Defines functions to read and write JSON values when handling HTTP requests.</p></div></desc><link>handy_http_data.json.html</link><decl id="20" type="function"><name>readJsonBodyAs</name><desc><div><p>Reads a JSON value from the body of the given HTTP request, parsing it using
|
|
the ASDF library according to the template type T.</p></div></desc><link>handy_http_data.json.readJsonBodyAs.html</link></decl><decl id="21" type="function"><name>writeJsonBody</name><desc><div><p>Writes a JSON value to the body of the given HTTP response, serializing it
|
|
using the ASDF library. Will also set Content-Type and Content-Length
|
|
headers before writing.</p></div></desc><link>handy_http_data.json.writeJsonBody.html</link></decl></decl><decl id="22" type="module"><name>handy_http_data.multipart</name><desc><div><p>Defines data structures and parsing methods for dealing with multipart
|
|
encoded request bodies.</p></div></desc><link>handy_http_data.multipart.html</link><decl id="23" type="struct"><name>MultipartElement</name><desc><div><p>A single element that's part of a multipart/form-data body.</p></div></desc><link>handy_http_data.multipart.MultipartElement.html</link><decl id="24" type="variable"><name>name</name><desc><div><p>The name of this element, as declared by this part's Content-Disposition
|
|
header <tt class="inline-code">name</tt> property. There is no guarantee that this name is unique
|
|
among all elements.</p></div></desc><link>handy_http_data.multipart.MultipartElement.name.html</link></decl><decl id="25" type="variable"><name>filename</name><desc><div><p>The filename of this element, as declared by this part's
|
|
Content-Disposition header <tt class="inline-code">filename</tt> property. Note that this may be
|
|
null if no filename exists.</p></div></desc><link>handy_http_data.multipart.MultipartElement.filename.html</link></decl><decl id="26" type="variable"><name>headers</name><desc><div><p>The headers that were present with this element.</p></div></desc><link>handy_http_data.multipart.MultipartElement.headers.html</link></decl><decl id="27" type="variable"><name>content</name><desc><div><p>The body content of this element.</p></div></desc><link>handy_http_data.multipart.MultipartElement.content.html</link></decl></decl><decl id="28" type="struct"><name>MultipartFormData</name><desc><div><p>A multipart/form-data body containing multiple elements, and some helper
|
|
methods for those elements.</p></div></desc><link>handy_http_data.multipart.MultipartFormData.html</link><decl id="29" type="variable"><name>elements</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_data.multipart.MultipartFormData.elements.html</link></decl><decl id="30" type="function"><name>has</name><desc><div><p>Determines if this form-data has an element with the given name. This
|
|
is case-sensitive. Note that there may be more than one element with a
|
|
given name.</p></div></desc><link>handy_http_data.multipart.MultipartFormData.has.html</link></decl></decl><decl id="31" type="class"><name>MultipartFormatException</name><desc><div><p>An exception that's thrown if parsing multipart/form-data fails due to
|
|
invalid formatting or unexpected characters. This is a sub-class of the
|
|
<tt class="inline-code">HttpStatusException</tt>, with each multipart exception being a BAD_REQUEST.</p></div></desc><link>handy_http_data.multipart.MultipartFormatException.html</link><decl id="32" type="constructor"><name>this</name><desc><div><span class="undocumented-note">Undocumented in source.</span></div></desc><link>handy_http_data.multipart.MultipartFormatException.this.html</link></decl></decl><decl id="33" type="variable"><name>MAX_ELEMENTS</name><desc><div><p>The maximum number of parts to read in a multipart/form-data body. This is
|
|
declared as a safety measure to avoid infinite reading of malicious or
|
|
corrupted payloads.</p></div></desc><link>handy_http_data.multipart.MAX_ELEMENTS.html</link></decl><decl id="34" type="function"><name>readBodyAsMultipartFormData</name><desc><div><p>Reads a request's body as multipart/form-data encoded elements.</p></div></desc><link>handy_http_data.multipart.readBodyAsMultipartFormData.html</link></decl><decl id="35" type="function"><name>parseMultipartFormData</name><desc><div><p>A simple linear parser for multipart/form-data encoded content. Reads a
|
|
series of elements separated by a given boundary. An exception is thrown
|
|
if the given content doesn't conform to standard multipart format.</p></div></desc><link>handy_http_data.multipart.parseMultipartFormData.html</link></decl></decl><decl id="36" type="module"><name>handy_http_data.xml</name><desc><div><p>Defines functions for reading and writing XML content while handling HTTP
|
|
requests, using the dxml library: <a href="https://code.dlang.org/packages/dxml">https://code.dlang.org/packages/dxml</a></p></div></desc><link>handy_http_data.xml.html</link><decl id="37" type="function"><name>readXMLBody</name><desc><div><p>Reads an XML request body.</p></div></desc><link>handy_http_data.xml.readXMLBody.html</link></decl><decl id="38" type="function"><name>writeXMLBody</name><desc><div><p>Writes an XML response body, by using the provided delegate function to
|
|
compose the XML tag tree using a provided XMLWriter.</p></div></desc><link>handy_http_data.xml.writeXMLBody.html</link></decl></decl></decl><decl id="39" type="module"><name>handy_http_data.xml</name><desc><div><p>Defines functions for reading and writing XML content while handling HTTP
|
|
requests, using the dxml library: <a href="https://code.dlang.org/packages/dxml">https://code.dlang.org/packages/dxml</a></p></div></desc><link>handy_http_data.xml.html</link><decl id="40" type="function"><name>readXMLBody</name><desc><div><p>Reads an XML request body.</p></div></desc><link>handy_http_data.xml.readXMLBody.html</link></decl><decl id="41" type="function"><name>writeXMLBody</name><desc><div><p>Writes an XML response body, by using the provided delegate function to
|
|
compose the XML tag tree using a provided XMLWriter.</p></div></desc><link>handy_http_data.xml.writeXMLBody.html</link></decl></decl></listing>
|
|
<index>
|
|
</index>
|
|
</adrdox>
|
|
</script>
|
|
<script src="search-docs.js"></script>
|
|
</body></html>
|