130 lines
7 KiB
HTML
130 lines
7 KiB
HTML
|
<!DOCTYPE html>
|
|||
|
|
<html lang="en">
|
|||
|
|
<head>
|
|||
|
|
<meta charset="utf-8">
|
|||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|||
|
|
<meta name="generator" content="rustdoc">
|
|||
|
|
<meta name="description" content="API documentation for the Rust `parse_headers` fn in crate `httparse`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, parse_headers">
|
|||
|
|
|
|||
|
|
<title>httparse::parse_headers - Rust</title>
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../rustdoc.css">
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../main.css">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</head>
|
|||
|
|
<body class="rustdoc">
|
|||
|
|
<!--[if lte IE 8]>
|
|||
|
|
<div class="warning">
|
|||
|
|
This old browser is unsupported and will most likely display funky
|
|||
|
|
things.
|
|||
|
|
</div>
|
|||
|
|
<![endif]-->
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<nav class="sidebar">
|
|||
|
|
|
|||
|
|
<p class='location'><a href='index.html'>httparse</a></p><script>window.sidebarCurrent = {name: 'parse_headers', ty: 'fn', relpath: ''};</script><script defer src="sidebar-items.js"></script>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<nav class="sub">
|
|||
|
|
<form class="search-form js-only">
|
|||
|
|
<div class="search-container">
|
|||
|
|
<input class="search-input" name="search"
|
|||
|
|
autocomplete="off"
|
|||
|
|
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
|||
|
|
type="search">
|
|||
|
|
</div>
|
|||
|
|
</form>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section id='main' class="content fn">
|
|||
|
|
<h1 class='fqn'><span class='in-band'>Function <a href='index.html'>httparse</a>::<wbr><a class='fn' href=''>parse_headers</a></span><span class='out-of-band'><span id='render-detail'>
|
|||
|
|
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
|
|||
|
|
[<span class='inner'>−</span>]
|
|||
|
|
</a>
|
|||
|
|
</span><a id='src-367' class='srclink' href='../src/httparse/lib.rs.html#420-425' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<pre class='rust fn'>pub fn parse_headers<'b: 'h, 'h>(src: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.slice.html'>&'b [</a><a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u8.html'>u8</a><a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.slice.html'>]</a>, dst: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.slice.html'>&'h mut [</a><a class='struct' href='../httparse/struct.Header.html' title='httparse::Header'>Header</a><'b><a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.slice.html'>]</a>) -> <a class='type' href='../httparse/type.Result.html' title='httparse::Result'>Result</a><<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.tuple.html'>(</a><a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.usize.html'>usize</a>, <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.slice.html'>&'h [</a><a class='struct' href='../httparse/struct.Header.html' title='httparse::Header'>Header</a><'b><a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.slice.html'>]</a><a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.tuple.html'>)</a>></pre><div class='docblock'><p>Parse a buffer of bytes as headers.</p>
|
|||
|
|
|
|||
|
|
<p>The return value, if complete and successful, includes the index of the
|
|||
|
|
buffer that parsing stopped at, and a sliced reference to the parsed
|
|||
|
|
headers. The length of the slice will be equal to the number of properly
|
|||
|
|
parsed headers.</p>
|
|||
|
|
|
|||
|
|
<h1 id='example' class='section-header'><a href='#example'>Example</a></h1>
|
|||
|
|
<pre class='rust rust-example-rendered'>
|
|||
|
|
<span class='kw'>let</span> <span class='ident'>buf</span> <span class='op'>=</span> <span class='string'>b"Host: foo.bar\nAccept: */*\n\nblah blah"</span>;
|
|||
|
|
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>headers</span> <span class='op'>=</span> [<span class='ident'>httparse</span>::<span class='ident'>EMPTY_HEADER</span>; <span class='number'>4</span>];
|
|||
|
|
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>httparse</span>::<span class='ident'>parse_headers</span>(<span class='ident'>buf</span>, <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>headers</span>),
|
|||
|
|
<span class='prelude-val'>Ok</span>(<span class='ident'>httparse</span>::<span class='ident'>Status</span>::<span class='ident'>Complete</span>((<span class='number'>27</span>, <span class='kw-2'>&</span>[
|
|||
|
|
<span class='ident'>httparse</span>::<span class='ident'>Header</span> { <span class='ident'>name</span>: <span class='string'>"Host"</span>, <span class='ident'>value</span>: <span class='string'>b"foo.bar"</span> },
|
|||
|
|
<span class='ident'>httparse</span>::<span class='ident'>Header</span> { <span class='ident'>name</span>: <span class='string'>"Accept"</span>, <span class='ident'>value</span>: <span class='string'>b"*/*"</span> }
|
|||
|
|
][..]))));</pre>
|
|||
|
|
</div></section>
|
|||
|
|
<section id='search' class="content hidden"></section>
|
|||
|
|
|
|||
|
|
<section class="footer"></section>
|
|||
|
|
|
|||
|
|
<aside id="help" class="hidden">
|
|||
|
|
<div>
|
|||
|
|
<h1 class="hidden">Help</h1>
|
|||
|
|
|
|||
|
|
<div class="shortcuts">
|
|||
|
|
<h2>Keyboard Shortcuts</h2>
|
|||
|
|
|
|||
|
|
<dl>
|
|||
|
|
<dt>?</dt>
|
|||
|
|
<dd>Show this help dialog</dd>
|
|||
|
|
<dt>S</dt>
|
|||
|
|
<dd>Focus the search field</dd>
|
|||
|
|
<dt>⇤</dt>
|
|||
|
|
<dd>Move up in search results</dd>
|
|||
|
|
<dt>⇥</dt>
|
|||
|
|
<dd>Move down in search results</dd>
|
|||
|
|
<dt>⏎</dt>
|
|||
|
|
<dd>Go to active search result</dd>
|
|||
|
|
<dt>+</dt>
|
|||
|
|
<dd>Collapse/expand all sections</dd>
|
|||
|
|
</dl>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<div class="infos">
|
|||
|
|
<h2>Search Tricks</h2>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Prefix searches with a type followed by a colon (e.g.
|
|||
|
|
<code>fn:</code>) to restrict the search to a given type.
|
|||
|
|
</p>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Accepted types are: <code>fn</code>, <code>mod</code>,
|
|||
|
|
<code>struct</code>, <code>enum</code>,
|
|||
|
|
<code>trait</code>, <code>type</code>, <code>macro</code>,
|
|||
|
|
and <code>const</code>.
|
|||
|
|
</p>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Search functions by type signature (e.g.
|
|||
|
|
<code>vec -> usize</code> or <code>* -> vec</code>)
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</aside>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script>
|
|||
|
|
window.rootPath = "../";
|
|||
|
|
window.currentCrate = "httparse";
|
|||
|
|
window.playgroundUrl = "";
|
|||
|
|
</script>
|
|||
|
|
<script src="../jquery.js"></script>
|
|||
|
|
<script src="../main.js"></script>
|
|||
|
|
|
|||
|
|
<script defer src="../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|