mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-30 22:03:40 +01:00
62 lines
8.9 KiB
HTML
62 lines
8.9 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 `response` mod in crate `http`."><meta name="keywords" content="rust, rustlang, rust-lang, response"><title>http::response - 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="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><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 rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Module response</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><div id="sidebar-vars" data-name="response" data-ty="mod" data-relpath="../"></div><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></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><button type="button" class="help-button">?</button>
|
||
<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="in-band">Module <a href="../index.html">http</a>::<wbr><a class="mod" href="">response</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/http/response.rs.html#1-799" title="goto source code">[src]</a></span></h1><div class="docblock"><p>HTTP response types.</p>
|
||
<p>This module contains structs related to HTTP responses, notably the
|
||
<code>Response</code> type itself as well as a builder to create responses. Typically
|
||
you'll import the <code>http::Response</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>Response</code> to return</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">let</span> <span class="kw-2">mut</span> <span class="ident">builder</span> <span class="op">=</span> <span class="ident">Response</span>::<span class="ident">builder</span>()
|
||
.<span class="ident">header</span>(<span class="string">"Foo"</span>, <span class="string">"Bar"</span>)
|
||
.<span class="ident">status</span>(<span class="ident">StatusCode</span>::<span class="ident">OK</span>);
|
||
|
||
<span class="kw">if</span> <span class="ident">req</span>.<span class="ident">headers</span>().<span class="ident">contains_key</span>(<span class="string">"Another-Header"</span>) {
|
||
<span class="ident">builder</span> <span class="op">=</span> <span class="ident">builder</span>.<span class="ident">header</span>(<span class="string">"Another-Header"</span>, <span class="string">"Ack"</span>);
|
||
}
|
||
|
||
<span class="ident">builder</span>.<span class="ident">body</span>(())
|
||
}</pre></div>
|
||
<p>A simple 404 handler</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">not_found</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="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>(())
|
||
}</pre></div>
|
||
<p>Or otherwise inspecting the result of a request:</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">fn</span> <span class="ident">get</span>(<span class="ident">url</span>: <span class="kw-2">&</span><span class="ident">str</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="comment">// ...</span>
|
||
}
|
||
|
||
<span class="kw">let</span> <span class="ident">response</span> <span class="op">=</span> <span class="ident">get</span>(<span class="string">"https://www.rust-lang.org/"</span>).<span class="ident">unwrap</span>();
|
||
|
||
<span class="kw">if</span> <span class="op">!</span><span class="ident">response</span>.<span class="ident">status</span>().<span class="ident">is_success</span>() {
|
||
<span class="macro">panic</span><span class="macro">!</span>(<span class="string">"failed to get a successful response status!"</span>);
|
||
}
|
||
|
||
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">date</span>) <span class="op">=</span> <span class="ident">response</span>.<span class="ident">headers</span>().<span class="ident">get</span>(<span class="string">"Date"</span>) {
|
||
<span class="comment">// we've got a `Date` header!</span>
|
||
}
|
||
|
||
<span class="kw">let</span> <span class="ident">body</span> <span class="op">=</span> <span class="ident">response</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::response::Builder struct">Builder</a></td><td class="docblock-short"><p>An HTTP response builder</p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Parts.html" title="http::response::Parts struct">Parts</a></td><td class="docblock-short"><p>Component parts of an HTTP <code>Response</code></p>
|
||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Response.html" title="http::response::Response struct">Response</a></td><td class="docblock-short"><p>Represents an HTTP response</p>
|
||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="http"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |