161 lines
No EOL
22 KiB
HTML
161 lines
No EOL
22 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` struct in crate `hyper`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, Response">
|
||
|
||
<title>hyper::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="../dark.css">
|
||
<link rel="stylesheet" type="text/css" href="../light.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 Response</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.version">version</a><a href="#method.headers">headers</a><a href="#method.headers_mut">headers_mut</a><a href="#method.status">status</a><a href="#method.set_status">set_status</a><a href="#method.with_status">with_status</a><a href="#method.with_header">with_header</a><a href="#method.with_headers">with_headers</a><a href="#method.set_body">set_body</a><a href="#method.with_body">with_body</a><a href="#method.body_ref">body_ref</a><a href="#method.body">body</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Default">Default</a><a href="#impl-Debug">Debug</a><a href="#impl-Into%3CMessage%3C__ProtoResponse%2C%20B%3E%3E">Into<Message<__ProtoResponse, B>></a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">!Sync</a></div></div><p class='location'><a href='index.html'>hyper</a></p><script>window.sidebarCurrent = {name: 'Response', 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'>hyper</a>::<wbr><a class="struct" 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/hyper/proto/response.rs.html#14-21' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct Response<B = <a class="struct" href="../hyper/struct.Body.html" title="struct hyper::Body">Body</a>> { /* fields omitted */ }</pre></div><div class='docblock'><p>An HTTP Response</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'><table class='table-display'><tbody><tr><td><code>impl<B> <a class="struct" href="../hyper/struct.Response.html" title="struct hyper::Response">Response</a><B></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/hyper/proto/response.rs.html#23-107' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.new' class='fnname'>new</a>() -> <a class="struct" href="../hyper/struct.Response.html" title="struct hyper::Response">Response</a><B></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/hyper/proto/response.rs.html#26-28' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Constructs a default response</p>
|
||
</div><h4 id='method.version' class="method"><span id='version.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.version' class='fnname'>version</a>(&self) -> <a class="enum" href="../hyper/enum.HttpVersion.html" title="enum hyper::HttpVersion">HttpVersion</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/hyper/proto/response.rs.html#32' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Get the HTTP version of this response.</p>
|
||
</div><h4 id='method.headers' class="method"><span id='headers.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.headers' class='fnname'>headers</a>(&self) -> &<a class="struct" href="../hyper/header/struct.Headers.html" title="struct hyper::header::Headers">Headers</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/hyper/proto/response.rs.html#36' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Get the headers from the response.</p>
|
||
</div><h4 id='method.headers_mut' class="method"><span id='headers_mut.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.headers_mut' class='fnname'>headers_mut</a>(&mut self) -> &mut <a class="struct" href="../hyper/header/struct.Headers.html" title="struct hyper::header::Headers">Headers</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/hyper/proto/response.rs.html#40' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Get a mutable reference to the headers.</p>
|
||
</div><h4 id='method.status' class="method"><span id='status.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.status' class='fnname'>status</a>(&self) -> <a class="enum" href="../hyper/enum.StatusCode.html" title="enum hyper::StatusCode">StatusCode</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/hyper/proto/response.rs.html#44' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Get the status from the server.</p>
|
||
</div><h4 id='method.set_status' class="method"><span id='set_status.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.set_status' class='fnname'>set_status</a>(&mut self, status: <a class="enum" href="../hyper/enum.StatusCode.html" title="enum hyper::StatusCode">StatusCode</a>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/hyper/proto/response.rs.html#56-58' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set the <code>StatusCode</code> for this response.</p>
|
||
</div><h4 id='method.with_status' class="method"><span id='with_status.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.with_status' class='fnname'>with_status</a>(self, status: <a class="enum" href="../hyper/enum.StatusCode.html" title="enum hyper::StatusCode">StatusCode</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/hyper/proto/response.rs.html#64-67' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set the status and move the Response.</p>
|
||
<p>Useful for the "builder-style" pattern.</p>
|
||
</div><h4 id='method.with_header' class="method"><span id='with_header.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.with_header' class='fnname'>with_header</a><H: <a class="trait" href="../hyper/header/trait.Header.html" title="trait hyper::header::Header">Header</a>>(self, header: H) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/hyper/proto/response.rs.html#73-76' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set a header and move the Response.</p>
|
||
<p>Useful for the "builder-style" pattern.</p>
|
||
</div><h4 id='method.with_headers' class="method"><span id='with_headers.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.with_headers' class='fnname'>with_headers</a>(self, headers: <a class="struct" href="../hyper/header/struct.Headers.html" title="struct hyper::header::Headers">Headers</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/hyper/proto/response.rs.html#82-85' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set the headers and move the Response.</p>
|
||
<p>Useful for the "builder-style" pattern.</p>
|
||
</div><h4 id='method.set_body' class="method"><span id='set_body.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.set_body' class='fnname'>set_body</a><T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><B>>(&mut self, body: T)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/hyper/proto/response.rs.html#89-91' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set the body.</p>
|
||
</div><h4 id='method.with_body' class="method"><span id='with_body.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.with_body' class='fnname'>with_body</a><T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><B>>(self, body: T) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/hyper/proto/response.rs.html#97-100' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set the body and move the Response.</p>
|
||
<p>Useful for the "builder-style" pattern.</p>
|
||
</div><h4 id='method.body_ref' class="method"><span id='body_ref.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.body_ref' class='fnname'>body_ref</a>(&self) -> <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.reference.html">&</a>B></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/hyper/proto/response.rs.html#104' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Read the body.</p>
|
||
</div></div><h3 id='impl-1' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="struct" href="../hyper/struct.Response.html" title="struct hyper::Response">Response</a><<a class="struct" href="../hyper/struct.Body.html" title="struct hyper::Body">Body</a>></code><a href='#impl-1' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/hyper/proto/response.rs.html#109-115' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.body' class="method"><span id='body.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.body' class='fnname'>body</a>(self) -> <a class="struct" href="../hyper/struct.Body.html" title="struct hyper::Body">Body</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/hyper/proto/response.rs.html#112-114' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Take the <code>Body</code> of this response.</p>
|
||
</div></div>
|
||
<h2 id='implementations' class='small-section-header'>
|
||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||
</h2>
|
||
<div id='implementations-list'>
|
||
<h3 id='impl-Default' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<B> <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="../hyper/struct.Response.html" title="struct hyper::Response">Response</a><B></code><a href='#impl-Default' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/hyper/proto/response.rs.html#118-127' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.default' class="method"><span id='default.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default' class='fnname'>default</a>() -> <a class="struct" href="../hyper/struct.Response.html" title="struct hyper::Response">Response</a><B></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/hyper/proto/response.rs.html#119-126' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the "default value" for a type. <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default">Read more</a></p>
|
||
</div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <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="../hyper/struct.Response.html" title="struct hyper::Response">Response</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/hyper/proto/response.rs.html#142-150' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &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></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/hyper/proto/response.rs.html#143-149' title='goto source code'>[src]</a></td></tr></tbody></table></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-Into%3CMessage%3C__ProtoResponse%2C%20B%3E%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<B> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../tokio_proto/streaming/message/enum.Message.html" title="enum tokio_proto::streaming::message::Message">Message</a><__ProtoResponse, B>> for <a class="struct" href="../hyper/struct.Response.html" title="struct hyper::Response">Response</a><B></code><a href='#impl-Into%3CMessage%3C__ProtoResponse%2C%20B%3E%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/hyper/server/server_proto.rs.html#223-233' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.into' class="method"><span id='into.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into' class='fnname'>into</a>(self) -> <a class="enum" href="../tokio_proto/streaming/message/enum.Message.html" title="enum tokio_proto::streaming::message::Message">Message</a><__ProtoResponse, B></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/hyper/server/server_proto.rs.html#225-232' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></div></div>
|
||
<h2 id='synthetic-implementations' class='small-section-header'>
|
||
Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
|
||
</h2>
|
||
<div id='synthetic-implementations-list'>
|
||
<h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<B> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../hyper/struct.Response.html" title="struct hyper::Response">Response</a><B> <span class="where fmt-newline">where<br> B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<B = <a class="struct" href="../hyper/struct.Body.html" title="struct hyper::Body">Body</a>> !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../hyper/struct.Response.html" title="struct hyper::Response">Response</a><B></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></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 = "hyper";
|
||
</script>
|
||
<script src="../main.js"></script>
|
||
<script defer src="../search-index.js"></script>
|
||
</body>
|
||
</html> |