195 lines
17 KiB
HTML
195 lines
17 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 `Request` struct in crate `httparse`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, Request">
|
|||
|
|
|
|||
|
|
<title>httparse::Request - 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="../main.css" id="themeStyle">
|
|||
|
|
<script src="../storage.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</head>
|
|||
|
|
<body class="rustdoc struct">
|
|||
|
|
<!--[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>
|
|||
|
|
|
|||
|
|
<p class='location'>Struct Request</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#fields">Fields</a><div class="sidebar-links"><a href="#structfield.method">method</a><a href="#structfield.path">path</a><a href="#structfield.version">version</a><a href="#structfield.headers">headers</a></div><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.parse">parse</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-PartialEq">PartialEq</a></div></div><p class='location'><a href='index.html'>httparse</a></p><script>window.sidebarCurrent = {name: 'Request', ty: 'struct', 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 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">
|
|||
|
|
<h1 class='fqn'><span class='in-band'>Struct <a href='index.html'>httparse</a>::<wbr><a class="struct" href=''>Request</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 class='srclink' href='../src/httparse/lib.rs.html#268-277' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<pre class='rust struct'>pub struct Request<'headers, 'buf: 'headers> {
|
|||
|
|
pub method: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'buf <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>,
|
|||
|
|
pub path: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'buf <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>,
|
|||
|
|
pub version: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>>,
|
|||
|
|
pub headers: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'headers mut [</a><a class="struct" href="../httparse/struct.Header.html" title="struct httparse::Header">Header</a><'buf><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>,
|
|||
|
|
}</pre><div class='docblock'><p>A parsed Request.</p>
|
|||
|
|
<p>The optional values will be <code>None</code> if a parse was not complete, and did not
|
|||
|
|
parse the associated property. This allows you to inspect the parts that
|
|||
|
|
could be parsed, before reading more, in case you wish to exit early.</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"GET /404 HTTP/1.1\r\nHost:"</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">16</span>];
|
|||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">req</span> <span class="op">=</span> <span class="ident">httparse</span>::<span class="ident">Request</span>::<span class="ident">new</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">headers</span>);
|
|||
|
|
<span class="kw">let</span> <span class="ident">res</span> <span class="op">=</span> <span class="ident">req</span>.<span class="ident">parse</span>(<span class="ident">buf</span>).<span class="ident">unwrap</span>();
|
|||
|
|
<span class="kw">if</span> <span class="ident">res</span>.<span class="ident">is_partial</span>() {
|
|||
|
|
<span class="kw">match</span> <span class="ident">req</span>.<span class="ident">path</span> {
|
|||
|
|
<span class="prelude-val">Some</span>(<span class="kw-2">ref</span> <span class="ident">path</span>) <span class="op">=></span> {
|
|||
|
|
<span class="comment">// check router for path.</span>
|
|||
|
|
<span class="comment">// /404 doesn't exist? we could stop parsing</span>
|
|||
|
|
},
|
|||
|
|
<span class="prelude-val">None</span> <span class="op">=></span> {
|
|||
|
|
<span class="comment">// must read more and parse again</span>
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
}</pre>
|
|||
|
|
</div><h2 id='fields' class='fields small-section-header'>
|
|||
|
|
Fields<a href='#fields' class='anchor'></a></h2><span id="structfield.method" class="structfield small-section-header">
|
|||
|
|
<a href="#structfield.method" class="anchor field"></a>
|
|||
|
|
<span id="method.v" class='invisible'>
|
|||
|
|
<code>method: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'buf <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>></code>
|
|||
|
|
</span></span><div class='docblock'><p>The request method, such as <code>GET</code>.</p>
|
|||
|
|
</div><span id="structfield.path" class="structfield small-section-header">
|
|||
|
|
<a href="#structfield.path" class="anchor field"></a>
|
|||
|
|
<span id="path.v" class='invisible'>
|
|||
|
|
<code>path: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'buf <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>></code>
|
|||
|
|
</span></span><div class='docblock'><p>The request path, such as <code>/about-us</code>.</p>
|
|||
|
|
</div><span id="structfield.version" class="structfield small-section-header">
|
|||
|
|
<a href="#structfield.version" class="anchor field"></a>
|
|||
|
|
<span id="version.v" class='invisible'>
|
|||
|
|
<code>version: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>></code>
|
|||
|
|
</span></span><div class='docblock'><p>The request version, such as <code>HTTP/1.1</code>.</p>
|
|||
|
|
</div><span id="structfield.headers" class="structfield small-section-header">
|
|||
|
|
<a href="#structfield.headers" class="anchor field"></a>
|
|||
|
|
<span id="headers.v" class='invisible'>
|
|||
|
|
<code>headers: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'headers mut [</a><a class="struct" href="../httparse/struct.Header.html" title="struct httparse::Header">Header</a><'buf><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code>
|
|||
|
|
</span></span><div class='docblock'><p>The request headers.</p>
|
|||
|
|
</div>
|
|||
|
|
<h2 id='methods' class='small-section-header'>
|
|||
|
|
Methods<a href='#methods' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<h3 id='impl' class='impl'><span class='in-band'><code>impl<'h, 'b> <a class="struct" href="../httparse/struct.Request.html" title="struct httparse::Request">Request</a><'h, 'b></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/httparse/lib.rs.html#279-306' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>pub fn <a href='#method.new' class='fnname'>new</a>(headers: <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>) -> <a class="struct" href="../httparse/struct.Request.html" title="struct httparse::Request">Request</a><'h, 'b></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/httparse/lib.rs.html#282-289' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Creates a new Request, using a slice of headers you allocate.</p>
|
|||
|
|
</div><h4 id='method.parse' class="method"><span id='parse.v' class='invisible'><code>pub fn <a href='#method.parse' class='fnname'>parse</a>(&mut self, buf: <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>) -> <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.usize.html">usize</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/httparse/lib.rs.html#292-305' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Try to parse a buffer of bytes into the Request.</p>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='implementations' class='small-section-header'>
|
|||
|
|
Trait Implementations<a href='#implementations' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl<'headers, 'buf: 'headers> <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../httparse/struct.Request.html" title="struct httparse::Request">Request</a><'headers, 'buf></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/httparse/lib.rs.html#267' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, __arg_0: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/httparse/lib.rs.html#267' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
|||
|
|
</div></div><h3 id='impl-PartialEq' class='impl'><span class='in-band'><code>impl<'headers, 'buf: 'headers> <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> for <a class="struct" href="../httparse/struct.Request.html" title="struct httparse::Request">Request</a><'headers, 'buf></code><a href='#impl-PartialEq' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/httparse/lib.rs.html#267' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.eq' class="method"><span id='eq.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&self, __arg_0: &<a class="struct" href="../httparse/struct.Request.html" title="struct httparse::Request">Request</a><'headers, 'buf>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/httparse/lib.rs.html#267' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
|
|||
|
|
</div><h4 id='method.ne' class="method"><span id='ne.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&self, __arg_0: &<a class="struct" href="../httparse/struct.Request.html" title="struct httparse::Request">Request</a><'headers, 'buf>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/httparse/lib.rs.html#267' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>This method tests for <code>!=</code>.</p>
|
|||
|
|
</div></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><kbd>?</kbd></dt>
|
|||
|
|
<dd>Show this help dialog</dd>
|
|||
|
|
<dt><kbd>S</kbd></dt>
|
|||
|
|
<dd>Focus the search field</dd>
|
|||
|
|
<dt><kbd>↑</kbd></dt>
|
|||
|
|
<dd>Move up in search results</dd>
|
|||
|
|
<dt><kbd>↓</kbd></dt>
|
|||
|
|
<dd>Move down in search results</dd>
|
|||
|
|
<dt><kbd>↹</kbd></dt>
|
|||
|
|
<dd>Switch tab</dd>
|
|||
|
|
<dt><kbd>⏎</kbd></dt>
|
|||
|
|
<dd>Go to active search result</dd>
|
|||
|
|
<dt><kbd>+</kbd></dt>
|
|||
|
|
<dd>Expand all sections</dd>
|
|||
|
|
<dt><kbd>-</kbd></dt>
|
|||
|
|
<dd>Collapse 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";
|
|||
|
|
</script>
|
|||
|
|
<script src="../main.js"></script>
|
|||
|
|
<script defer src="../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|