15 lines
6.1 KiB
HTML
15 lines
6.1 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="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc fn"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../httparse/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><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></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><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 class='srclink' href='../src/httparse/lib.rs.html#566-571' title='goto source code'>[src]</a></span><span class='in-band'>Function <a href='index.html'>httparse</a>::<wbr><a class="fn" href=''>parse_headers</a></span></h1><pre class='rust fn'>pub fn parse_headers<'b: 'h, 'h>(<br> 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>, <br> 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="struct httparse::Header">Header</a><'b><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a><br>) -> <a class="type" href="../httparse/type.Result.html" title="type 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="struct 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>
|
||
<div class="example-wrap"><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>
|
||
</div></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "httparse";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |