website/docs/ddoc/data/handy_http_data.multipart.p...

39 lines
5.0 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<title>parseMultipartFormData (handy_http_data.multipart.parseMultipartFormData)</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>parseMultipartFormData</h1><div class="breadcrumbs"><a class="breadcrumb" href="handy_http_data.html">handy_http_data</a> <a class="breadcrumb" href="handy_http_data.multipart.html">multipart</a> </div><div><div class="documentation-comment synopsis"><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><p>The main purpose of this function is to parse the multipart boundaries and
hand-off parsing of each element to <tt class="inline-code">readElement</tt>.</p></div></div></div><div class="annotated-prototype"><div class="function-prototype"><div class="attributes"></div><div class="return-type"><a class="name" data-ident="MultipartFormData" href="handy_http_data.multipart.MultipartFormData.html" title="handy_http_data.multipart.MultipartFormData">MultipartFormData</a></div><div class="function-name">parseMultipartFormData</div><div class="template-parameters" data-count="0"></div><div class="runtime-parameters" data-count="2"><div class="parameters-list toplevel"><span class="paren">(</span><div class="runtime-parameter-item parameter-item"><span class="parameter-type-holder"><span class="parameter-type"><span class="builtin-type">string</span></span></span> <span class="parameter-name name" data-ident="content"><a href="#param-content">content</a></span></div><span class="comma">,</span><div class="runtime-parameter-item parameter-item"><span class="parameter-type-holder"><span class="parameter-type"><span class="builtin-type">string</span></span></span> <span class="parameter-name name" data-ident="boundary"><a href="#param-boundary">boundary</a></span></div><span class="paren">)</span></div></div><div class="function-contracts"></div></div></div><div><h2 id="parameters"><a class="header-anchor" href="#parameters">Parameters</a></h2><dl class="parameter-descriptions"><dt id="param-content"><a class="parameter-name" data-ident="content" href="#param-content">content</a> <span class="parameter-type"><span class="builtin-type">string</span></span></dt><dd><div class="documentation-comment"><div><p>The content to parse.</p></div></div></dd><dt id="param-boundary"><a class="parameter-name" data-ident="boundary" href="#param-boundary">boundary</a> <span class="parameter-type"><span class="builtin-type">string</span></span></dt><dd><div class="documentation-comment"><div><p>The boundary between parts. This is usually present in an HTTP
request's Content-Type header.</p></div></div></dd></dl><h2 id="returns"><a class="header-anchor" href="#returns">Return Value</a></h2><div><div class="return-type-holder">Type: <span class="return-type"><a class="xref" href="handy_http_data.multipart.MultipartFormData.html" title="handy_http_data.multipart.MultipartFormData"><span class="name" data-ident="MultipartFormData">MultipartFormData</span></a></span></div><div class="documentation-comment returns-description"><div><p>The multipart/form-data content that's been parsed.</p></div></div></div></div></div>
<div id="page-nav"><a class="parent" href="handy_http_data.html">handy_http_data</a> <a class="parent" href="handy_http_data.multipart.html">multipart</a>
<span class="type-separator">classes</span><ul><li><a class="class" href="handy_http_data.multipart.MultipartFormatException.html">MultipartFormatException</a></li></ul><span class="type-separator">functions</span><ul><li><a class="function current" href="handy_http_data.multipart.parseMultipartFormData.html">parseMultipartFormData</a></li><li><a class="function" href="handy_http_data.multipart.readBodyAsMultipartFormData.html">readBodyAsMultipartFormData</a></li></ul><span class="type-separator">structs</span><ul><li><a class="struct" href="handy_http_data.multipart.MultipartElement.html">MultipartElement</a></li><li><a class="struct" href="handy_http_data.multipart.MultipartFormData.html">MultipartFormData</a></li></ul><span class="type-separator">variables</span><ul><li><a class="variable" href="handy_http_data.multipart.MAX_ELEMENTS.html">MAX_ELEMENTS</a></li></ul></div>
</div>
<div id="page-footer">Page generated by <a href="https://github.com/adamdruppe/adrdox">adrdox</a></div>
</body>
</html>