43 lines
4.8 KiB
HTML
43 lines
4.8 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<title>handy_http_data.multipart (handy_http_data.multipart)</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>handy_http_data.multipart</h1><div class="breadcrumbs"><a class="breadcrumb" href="handy_http_data.html">handy_http_data</a> </div><div><div class="documentation-comment synopsis"><div><p>Defines data structures and parsing methods for dealing with multipart
|
|
encoded request bodies.</p></div></div></div><div class="annotated-prototype"></div><h2 id="members"><a class="header-anchor" href="#members">Members</a></h2><h3 class="member-list-header hide-from-toc" id="class"><a class="header-anchor" href="#class">Classes</a></h3><dl class="member-list native"><dt><a href="handy_http_data.multipart.MultipartFormatException.html">MultipartFormatException</a><div class="simplified-prototype" style="max-width: 33ch;"><span class="builtin-type">class</span> <span class="name">MultipartFormatException</span></div></dt><dd><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></dd></dl><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_data.multipart.parseMultipartFormData.html">parseMultipartFormData</a><div class="simplified-prototype" style="max-width: 80ch;"><tt class="highlighted"><span class="hid">MultipartFormData</span></tt> <span class="name">parseMultipartFormData</span>(string content, string boundary)</div></dt><dd><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></dd><dt><a href="handy_http_data.multipart.readBodyAsMultipartFormData.html">readBodyAsMultipartFormData</a><div class="simplified-prototype" style="max-width: 105ch;"><tt class="highlighted"><span class="hid">MultipartFormData</span></tt> <span class="name">readBodyAsMultipartFormData</span>(ServerHttpRequest request, bool allowInfiniteRead)</div></dt><dd><div><p>Reads a request's body as multipart/form-data encoded elements.</p></div></dd></dl><h3 class="member-list-header hide-from-toc" id="struct"><a class="header-anchor" href="#struct">Structs</a></h3><dl class="member-list native"><dt><a href="handy_http_data.multipart.MultipartElement.html">MultipartElement</a><div class="simplified-prototype" style="max-width: 25ch;"><span class="builtin-type">struct</span> <span class="name">MultipartElement</span></div></dt><dd><div><p>A single element that's part of a multipart/form-data body.</p></div></dd><dt><a href="handy_http_data.multipart.MultipartFormData.html">MultipartFormData</a><div class="simplified-prototype" style="max-width: 26ch;"><span class="builtin-type">struct</span> <span class="name">MultipartFormData</span></div></dt><dd><div><p>A multipart/form-data body containing multiple elements, and some helper
|
|
methods for those elements.</p></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_data.multipart.MAX_ELEMENTS.html">MAX_ELEMENTS</a><div class="simplified-prototype" style="max-width: 19ch;"><span class="builtin-type">auto</span> <span class="name">MAX_ELEMENTS</span>;</div></dt><dd><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></dd></dl><div></div></div>
|
|
<div id="page-nav"><a class="parent" href="handy_http_data.html">handy_http_data</a>
|
|
<span class="type-separator">modules</span><ul><li><a class="module" href="handy_http_data.json.html">json</a></li><li><a class="module current" href="handy_http_data.multipart.html">multipart</a></li><li><a class="module" href="handy_http_data.xml.html">xml</a></li></ul></div>
|
|
</div>
|
|
<div id="page-footer">Page generated by <a href="https://github.com/adamdruppe/adrdox">adrdox</a></div>
|
|
</body>
|
|
</html> |