46 lines
7.3 KiB
HTML
46 lines
7.3 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` mod in crate `http`."><meta name="keywords" content="rust, rustlang, rust-lang, request"><title>http::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="../../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 mod"><!--[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='../../http/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Module request</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li></ul></div><p class='location'><a href='../index.html'>http</a></p><script>window.sidebarCurrent = {name: 'request', ty: 'mod', 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/http/request.rs.html#1-1069' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../index.html'>http</a>::<wbr><a class="mod" href=''>request</a></span></h1><div class='docblock'><p>HTTP request types.</p>
|
||
<p>This module contains structs related to HTTP requests, notably the
|
||
<code>Request</code> type itself as well as a builder to create requests. Typically
|
||
you'll import the <code>http::Request</code> type rather than reaching into this
|
||
module itself.</p>
|
||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
<p>Creating a <code>Request</code> to send</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">http</span>::{<span class="ident">Request</span>, <span class="ident">Response</span>};
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">request</span> <span class="op">=</span> <span class="ident">Request</span>::<span class="ident">builder</span>();
|
||
<span class="ident">request</span>.<span class="ident">uri</span>(<span class="string">"https://www.rust-lang.org/"</span>)
|
||
.<span class="ident">header</span>(<span class="string">"User-Agent"</span>, <span class="string">"my-awesome-agent/1.0"</span>);
|
||
|
||
<span class="kw">if</span> <span class="ident">needs_awesome_header</span>() {
|
||
<span class="ident">request</span>.<span class="ident">header</span>(<span class="string">"Awesome"</span>, <span class="string">"yes"</span>);
|
||
}
|
||
|
||
<span class="kw">let</span> <span class="ident">response</span> <span class="op">=</span> <span class="ident">send</span>(<span class="ident">request</span>.<span class="ident">body</span>(()).<span class="ident">unwrap</span>());
|
||
|
||
<span class="kw">fn</span> <span class="ident">send</span>(<span class="ident">req</span>: <span class="ident">Request</span><span class="op"><</span>()<span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">Response</span><span class="op"><</span>()<span class="op">></span> {
|
||
<span class="comment">// ...</span>
|
||
}</pre></div>
|
||
<p>Inspecting a request to see what was sent.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">http</span>::{<span class="ident">Request</span>, <span class="ident">Response</span>, <span class="ident">StatusCode</span>};
|
||
|
||
<span class="kw">fn</span> <span class="ident">respond_to</span>(<span class="ident">req</span>: <span class="ident">Request</span><span class="op"><</span>()<span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">http</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Response</span><span class="op"><</span>()<span class="op">></span><span class="op">></span> {
|
||
<span class="kw">if</span> <span class="ident">req</span>.<span class="ident">uri</span>() <span class="op">!</span><span class="op">=</span> <span class="string">"/awesome-url"</span> {
|
||
<span class="kw">return</span> <span class="ident">Response</span>::<span class="ident">builder</span>()
|
||
.<span class="ident">status</span>(<span class="ident">StatusCode</span>::<span class="ident">NOT_FOUND</span>)
|
||
.<span class="ident">body</span>(())
|
||
}
|
||
|
||
<span class="kw">let</span> <span class="ident">has_awesome_header</span> <span class="op">=</span> <span class="ident">req</span>.<span class="ident">headers</span>().<span class="ident">contains_key</span>(<span class="string">"Awesome"</span>);
|
||
<span class="kw">let</span> <span class="ident">body</span> <span class="op">=</span> <span class="ident">req</span>.<span class="ident">body</span>();
|
||
|
||
<span class="comment">// ...</span>
|
||
}</pre></div>
|
||
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table><tr class='module-item'><td><a class="struct" href="struct.Builder.html" title='http::request::Builder struct'>Builder</a></td><td class='docblock-short'><p>An HTTP request builder</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Parts.html" title='http::request::Parts struct'>Parts</a></td><td class='docblock-short'><p>Component parts of an HTTP <code>Request</code></p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Request.html" title='http::request::Request struct'>Request</a></td><td class='docblock-short'><p>Represents an HTTP request.</p>
|
||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../";window.currentCrate = "http";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |