38 lines
22 KiB
HTML
38 lines
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 `HttpMessage` trait in crate `actix_http`."><meta name="keywords" content="rust, rustlang, rust-lang, HttpMessage"><title>actix_http::httpmessage::HttpMessage - 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 trait"><!--[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='../../actix_http/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Trait HttpMessage</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Stream">Stream</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.extensions">extensions</a><a href="#tymethod.extensions_mut">extensions_mut</a><a href="#tymethod.headers">headers</a><a href="#tymethod.take_payload">take_payload</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.chunked">chunked</a><a href="#method.content_type">content_type</a><a href="#method.cookie">cookie</a><a href="#method.cookies">cookies</a><a href="#method.encoding">encoding</a><a href="#method.mime_type">mime_type</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-HttpMessage-for-%26%27a%20mut%20T">&'a mut T</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>actix_http</a>::<wbr><a href='index.html'>httpmessage</a></p><script>window.sidebarCurrent = {name: 'HttpMessage', ty: 'trait', 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/actix_http/httpmessage.rs.html#17-138' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../index.html'>actix_http</a>::<wbr><a href='index.html'>httpmessage</a>::<wbr><a class="trait" href=''>HttpMessage</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait HttpMessage: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
||
type <a href='#associatedtype.Stream' class="type">Stream</a>;
|
||
fn <a href='#tymethod.headers' class='fnname'>headers</a>(&self) -> &<a class="struct" href="../../actix_http/http/struct.HeaderMap.html" title="struct actix_http::http::HeaderMap">HeaderMap</a>;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.take_payload' class='fnname'>take_payload</a>(&mut self) -> <a class="enum" href="../../actix_http/enum.Payload.html" title="enum actix_http::Payload">Payload</a><Self::<a class="type" href="../../actix_http/httpmessage/trait.HttpMessage.html#associatedtype.Stream" title="type actix_http::httpmessage::HttpMessage::Stream">Stream</a>>;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.extensions' class='fnname'>extensions</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/cell/struct.Ref.html" title="struct core::cell::Ref">Ref</a><<a class="struct" href="../../actix_http/struct.Extensions.html" title="struct actix_http::Extensions">Extensions</a>>;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.extensions_mut' class='fnname'>extensions_mut</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/cell/struct.RefMut.html" title="struct core::cell::RefMut">RefMut</a><<a class="struct" href="../../actix_http/struct.Extensions.html" title="struct actix_http::Extensions">Extensions</a>>;
|
||
|
||
fn <a href='#method.content_type' class='fnname'>content_type</a>(&self) -> &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.encoding' class='fnname'>encoding</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><&'static <a class="struct" href="../../encoding_rs/struct.Encoding.html" title="struct encoding_rs::Encoding">Encoding</a>, <a class="enum" href="../../actix_http/error/enum.ContentTypeError.html" title="enum actix_http::error::ContentTypeError">ContentTypeError</a>> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.mime_type' class='fnname'>mime_type</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../mime/struct.Mime.html" title="struct mime::Mime">Mime</a>>, <a class="enum" href="../../actix_http/error/enum.ContentTypeError.html" title="enum actix_http::error::ContentTypeError">ContentTypeError</a>> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.chunked' class='fnname'>chunked</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, <a class="enum" href="../../actix_http/error/enum.ParseError.html" title="enum actix_http::error::ParseError">ParseError</a>> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.cookies' class='fnname'>cookies</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/core/cell/struct.Ref.html" title="struct core::cell::Ref">Ref</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="../../actix_http/cookie/struct.Cookie.html" title="struct actix_http::cookie::Cookie">Cookie</a><'static>>>, <a class="enum" href="../../actix_http/cookie/enum.ParseError.html" title="enum actix_http::cookie::ParseError">CookieParseError</a>> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.cookie' class='fnname'>cookie</a>(&self, name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../actix_http/cookie/struct.Cookie.html" title="struct actix_http::cookie::Cookie">Cookie</a><'static>> { ... }
|
||
}</pre></div><div class='docblock'><p>Trait that implements general purpose operations on http messages</p>
|
||
</div>
|
||
<h2 id='associated-types' class='small-section-header'>Associated Types<a href='#associated-types' class='anchor'></a></h2><div class='methods'><h3 id='associatedtype.Stream' class='method'><code id='Stream.t'>type <a href='#associatedtype.Stream' class="type">Stream</a></code></h3><div class='docblock'><p>Type of message payload stream</p>
|
||
</div></div><span class='loading-content'>Loading content...</span>
|
||
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.headers' class='method'><code id='headers.v'>fn <a href='#tymethod.headers' class='fnname'>headers</a>(&self) -> &<a class="struct" href="../../actix_http/http/struct.HeaderMap.html" title="struct actix_http::http::HeaderMap">HeaderMap</a></code></h3><div class='docblock'><p>Read the message headers.</p>
|
||
</div><h3 id='tymethod.take_payload' class='method'><code id='take_payload.v'>fn <a href='#tymethod.take_payload' class='fnname'>take_payload</a>(&mut self) -> <a class="enum" href="../../actix_http/enum.Payload.html" title="enum actix_http::Payload">Payload</a><Self::<a class="type" href="../../actix_http/httpmessage/trait.HttpMessage.html#associatedtype.Stream" title="type actix_http::httpmessage::HttpMessage::Stream">Stream</a>></code></h3><div class='docblock'><p>Message payload stream</p>
|
||
</div><h3 id='tymethod.extensions' class='method'><code id='extensions.v'>fn <a href='#tymethod.extensions' class='fnname'>extensions</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/cell/struct.Ref.html" title="struct core::cell::Ref">Ref</a><<a class="struct" href="../../actix_http/struct.Extensions.html" title="struct actix_http::Extensions">Extensions</a>></code></h3><div class='docblock'><p>Request's extensions container</p>
|
||
</div><h3 id='tymethod.extensions_mut' class='method'><code id='extensions_mut.v'>fn <a href='#tymethod.extensions_mut' class='fnname'>extensions_mut</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/cell/struct.RefMut.html" title="struct core::cell::RefMut">RefMut</a><<a class="struct" href="../../actix_http/struct.Extensions.html" title="struct actix_http::Extensions">Extensions</a>></code></h3><div class='docblock'><p>Mutable reference to a the request's extensions container</p>
|
||
</div></div><span class='loading-content'>Loading content...</span>
|
||
<h2 id='provided-methods' class='small-section-header'>Provided methods<a href='#provided-methods' class='anchor'></a></h2><div class='methods'><h3 id='method.content_type' class='method'><code id='content_type.v'>fn <a href='#method.content_type' class='fnname'>content_type</a>(&self) -> &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></code></h3><div class='docblock'><p>Read the request content type. If request does not contain
|
||
<em>Content-Type</em> header, empty str get returned.</p>
|
||
</div><h3 id='method.encoding' class='method'><code id='encoding.v'>fn <a href='#method.encoding' class='fnname'>encoding</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><&'static <a class="struct" href="../../encoding_rs/struct.Encoding.html" title="struct encoding_rs::Encoding">Encoding</a>, <a class="enum" href="../../actix_http/error/enum.ContentTypeError.html" title="enum actix_http::error::ContentTypeError">ContentTypeError</a>></code></h3><div class='docblock'><p>Get content type encoding</p>
|
||
<p>UTF-8 is used by default, If request charset is not set.</p>
|
||
</div><h3 id='method.mime_type' class='method'><code id='mime_type.v'>fn <a href='#method.mime_type' class='fnname'>mime_type</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../mime/struct.Mime.html" title="struct mime::Mime">Mime</a>>, <a class="enum" href="../../actix_http/error/enum.ContentTypeError.html" title="enum actix_http::error::ContentTypeError">ContentTypeError</a>></code></h3><div class='docblock'><p>Convert the request content type to a known mime type.</p>
|
||
</div><h3 id='method.chunked' class='method'><code id='chunked.v'>fn <a href='#method.chunked' class='fnname'>chunked</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, <a class="enum" href="../../actix_http/error/enum.ParseError.html" title="enum actix_http::error::ParseError">ParseError</a>></code></h3><div class='docblock'><p>Check if request has chunked transfer encoding</p>
|
||
</div><h3 id='method.cookies' class='method'><code id='cookies.v'>fn <a href='#method.cookies' class='fnname'>cookies</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/core/cell/struct.Ref.html" title="struct core::cell::Ref">Ref</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="../../actix_http/cookie/struct.Cookie.html" title="struct actix_http::cookie::Cookie">Cookie</a><'static>>>, <a class="enum" href="../../actix_http/cookie/enum.ParseError.html" title="enum actix_http::cookie::ParseError">CookieParseError</a>></code></h3><div class='docblock'><p>Load request cookies.</p>
|
||
</div><h3 id='method.cookie' class='method'><code id='cookie.v'>fn <a href='#method.cookie' class='fnname'>cookie</a>(&self, name: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../actix_http/cookie/struct.Cookie.html" title="struct actix_http::cookie::Cookie">Cookie</a><'static>></code></h3><div class='docblock'><p>Return request cookie.</p>
|
||
</div></div><span class='loading-content'>Loading content...</span>
|
||
<h2 id='foreign-impls' class='small-section-header'>Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a></h2><h3 id='impl-HttpMessage-for-%26%27a%20mut%20T' class='impl'><code class='in-band'>impl<'a, T> <a class="trait" href="../../actix_http/httpmessage/trait.HttpMessage.html" title="trait actix_http::httpmessage::HttpMessage">HttpMessage</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>T <span class="where fmt-newline">where<br> T: <a class="trait" href="../../actix_http/httpmessage/trait.HttpMessage.html" title="trait actix_http::httpmessage::HttpMessage">HttpMessage</a>, </span></code><a href='#impl-HttpMessage-for-%26%27a%20mut%20T' class='anchor'></a><a class='srclink' href='../../src/actix_http/httpmessage.rs.html#140-164' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Stream-1' class="type"><code id='Stream.t-1'>type <a href='#associatedtype.Stream' class="type">Stream</a> = T::<a class="type" href="../../actix_http/httpmessage/trait.HttpMessage.html#associatedtype.Stream" title="type actix_http::httpmessage::HttpMessage::Stream">Stream</a></code></h4><h4 id='method.headers' class="method hidden"><code id='headers.v-1'>fn <a href='#method.headers' class='fnname'>headers</a>(&self) -> &<a class="struct" href="../../actix_http/http/struct.HeaderMap.html" title="struct actix_http::http::HeaderMap">HeaderMap</a></code><a class='srclink' href='../../src/actix_http/httpmessage.rs.html#146-148' title='goto source code'>[src]</a></h4><h4 id='method.take_payload' class="method"><code id='take_payload.v-1'>fn <a href='#method.take_payload' class='fnname'>take_payload</a>(&mut self) -> <a class="enum" href="../../actix_http/enum.Payload.html" title="enum actix_http::Payload">Payload</a><Self::<a class="type" href="../../actix_http/httpmessage/trait.HttpMessage.html#associatedtype.Stream" title="type actix_http::httpmessage::HttpMessage::Stream">Stream</a>></code><a class='srclink' href='../../src/actix_http/httpmessage.rs.html#151-153' title='goto source code'>[src]</a></h4><div class='docblock'><p>Message payload stream</p>
|
||
</div><h4 id='method.extensions' class="method"><code id='extensions.v-1'>fn <a href='#method.extensions' class='fnname'>extensions</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/cell/struct.Ref.html" title="struct core::cell::Ref">Ref</a><<a class="struct" href="../../actix_http/struct.Extensions.html" title="struct actix_http::Extensions">Extensions</a>></code><a class='srclink' href='../../src/actix_http/httpmessage.rs.html#156-158' title='goto source code'>[src]</a></h4><div class='docblock'><p>Request's extensions container</p>
|
||
</div><h4 id='method.extensions_mut' class="method"><code id='extensions_mut.v-1'>fn <a href='#method.extensions_mut' class='fnname'>extensions_mut</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/cell/struct.RefMut.html" title="struct core::cell::RefMut">RefMut</a><<a class="struct" href="../../actix_http/struct.Extensions.html" title="struct actix_http::Extensions">Extensions</a>></code><a class='srclink' href='../../src/actix_http/httpmessage.rs.html#161-163' title='goto source code'>[src]</a></h4><div class='docblock'><p>Mutable reference to a the request's extensions container</p>
|
||
</div></div><span class='loading-content'>Loading content...</span>
|
||
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'><h3 id='impl-HttpMessage' class='impl'><code class='in-band'>impl<P> HttpMessage for <a class="struct" href="../../actix_http/struct.Request.html" title="struct actix_http::Request">Request</a><P></code><a href='#impl-HttpMessage' class='anchor'></a><a class='srclink' href='../../src/actix_http/request.rs.html#18-41' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Stream-2' class="type"><code id='Stream.t-2'>type <a href='#associatedtype.Stream-2' class="type">Stream</a> = P</code></h4><h4 id='method.headers-1' class="method hidden"><code id='headers.v-2'>fn <a href='#method.headers-1' class='fnname'>headers</a>(&self) -> &<a class="struct" href="../../actix_http/http/struct.HeaderMap.html" title="struct actix_http::http::HeaderMap">HeaderMap</a></code><a class='srclink' href='../../src/actix_http/request.rs.html#22-24' title='goto source code'>[src]</a></h4><h4 id='method.extensions-1' class="method"><code id='extensions.v-2'>fn <a href='#method.extensions-1' class='fnname'>extensions</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/cell/struct.Ref.html" title="struct core::cell::Ref">Ref</a><<a class="struct" href="../../actix_http/struct.Extensions.html" title="struct actix_http::Extensions">Extensions</a>></code><a class='srclink' href='../../src/actix_http/request.rs.html#28-30' title='goto source code'>[src]</a></h4><div class='docblock'><p>Request extensions</p>
|
||
</div><h4 id='method.extensions_mut-1' class="method"><code id='extensions_mut.v-2'>fn <a href='#method.extensions_mut-1' class='fnname'>extensions_mut</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/cell/struct.RefMut.html" title="struct core::cell::RefMut">RefMut</a><<a class="struct" href="../../actix_http/struct.Extensions.html" title="struct actix_http::Extensions">Extensions</a>></code><a class='srclink' href='../../src/actix_http/request.rs.html#34-36' title='goto source code'>[src]</a></h4><div class='docblock'><p>Mutable reference to a the request's extensions</p>
|
||
</div><h4 id='method.take_payload-1' class="method hidden"><code id='take_payload.v-2'>fn <a href='#method.take_payload-1' class='fnname'>take_payload</a>(&mut self) -> <a class="enum" href="../../actix_http/enum.Payload.html" title="enum actix_http::Payload">Payload</a><P></code><a class='srclink' href='../../src/actix_http/request.rs.html#38-40' title='goto source code'>[src]</a></h4></div></div><span class='loading-content'>Loading content...</span><script type="text/javascript" src="../../implementors/actix_http/httpmessage/trait.HttpMessage.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../";window.currentCrate = "actix_http";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |