mirror of
https://github.com/actix/actix-website
synced 2024-12-04 20:51:54 +01:00
46 lines
41 KiB
HTML
46 lines
41 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 `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, Request"><title>actix_web::server::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></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="#methods">Methods</a><div class="sidebar-links"><a href="#method.uri">uri</a><a href="#method.method">method</a><a href="#method.version">version</a><a href="#method.path">path</a><a href="#method.headers">headers</a><a href="#method.headers_mut">headers_mut</a><a href="#method.peer_addr">peer_addr</a><a href="#method.keep_alive">keep_alive</a><a href="#method.extensions">extensions</a><a href="#method.extensions_mut">extensions_mut</a><a href="#method.upgrade">upgrade</a><a href="#method.connection_info">connection_info</a><a href="#method.stream_extensions">stream_extensions</a><a href="#method.server_settings">server_settings</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-HttpMessage">HttpMessage</a><a href="#impl-Debug">Debug</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><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-From">From</a><a href="#impl-Into">Into</a><a href="#impl-TryFrom">TryFrom</a><a href="#impl-Borrow">Borrow</a><a href="#impl-BorrowMut">BorrowMut</a><a href="#impl-TryInto">TryInto</a><a href="#impl-Any">Any</a><a href="#impl-Erased">Erased</a></div></div><p class='location'><a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>server</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"><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_web/server/message.rs.html#24-26' title='goto source code'>[src]</a></span><span class='in-band'>Struct <a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>server</a>::<wbr><a class="struct" href=''>Request</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust struct'>pub struct Request { /* fields omitted */ }</pre></div><div class='docblock'><p>Request's context</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 <a class="struct" href="../../actix_web/struct.Request.html" title="struct actix_web::Request">Request</a></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/message.rs.html#71-222' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.uri' class="method"><span id='uri.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.uri' class='fnname'>uri</a>(&self) -> &<a class="struct" href="https://docs.rs/http/0.1.13/http/uri/struct.Uri.html" title="struct http::uri::Uri">Uri</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/message.rs.html#109-111' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Read the Request Uri.</p>
|
|||
|
|
</div><h4 id='method.method' class="method"><span id='method.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.method' class='fnname'>method</a>(&self) -> &<a class="struct" href="../../actix_web/http/struct.Method.html" title="struct actix_web::http::Method">Method</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/message.rs.html#115-117' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Read the Request method.</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="struct" href="../../actix_web/http/struct.Version.html" title="struct actix_web::http::Version">Version</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/message.rs.html#121-123' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Read the Request Version.</p>
|
|||
|
|
</div><h4 id='method.path' class="method"><span id='path.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.path' class='fnname'>path</a>(&self) -> &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/message.rs.html#127-129' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>The target path of this Request.</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="../../actix_web/http/header/struct.HeaderMap.html" title="struct actix_web::http::header::HeaderMap">HeaderMap</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/message.rs.html#133-135' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns Request's headers.</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="../../actix_web/http/header/struct.HeaderMap.html" title="struct actix_web::http::header::HeaderMap">HeaderMap</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/message.rs.html#139-141' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns mutable Request's headers.</p>
|
|||
|
|
</div><h4 id='method.peer_addr' class="method"><span id='peer_addr.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.peer_addr' class='fnname'>peer_addr</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="enum" href="https://doc.rust-lang.org/nightly/std/net/addr/enum.SocketAddr.html" title="enum std::net::addr::SocketAddr">SocketAddr</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/message.rs.html#150-152' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Peer socket address</p>
|
|||
|
|
<p>Peer address is actual socket address, if proxy is used in front of
|
|||
|
|
actix http server, then peer address would be address of this proxy.</p>
|
|||
|
|
<p>To get client connection information <code>connection_info()</code> method should
|
|||
|
|
be used.</p>
|
|||
|
|
</div><h4 id='method.keep_alive' class="method"><span id='keep_alive.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.keep_alive' class='fnname'>keep_alive</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/message.rs.html#156-158' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Checks if a connection should be kept alive.</p>
|
|||
|
|
</div><h4 id='method.extensions' class="method"><span id='extensions.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub 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_web/struct.Extensions.html" title="struct actix_web::Extensions">Extensions</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/message.rs.html#162-164' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Request extensions</p>
|
|||
|
|
</div><h4 id='method.extensions_mut' class="method"><span id='extensions_mut.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub 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_web/struct.Extensions.html" title="struct actix_web::Extensions">Extensions</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/message.rs.html#168-170' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Mutable reference to a the request's extensions</p>
|
|||
|
|
</div><h4 id='method.upgrade' class="method"><span id='upgrade.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.upgrade' class='fnname'>upgrade</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/message.rs.html#173-180' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Check if request requires connection upgrade</p>
|
|||
|
|
</div><h4 id='method.connection_info' class="method"><span id='connection_info.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.connection_info' class='fnname'>connection_info</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_web/dev/struct.ConnectionInfo.html" title="struct actix_web::dev::ConnectionInfo">ConnectionInfo</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/message.rs.html#183-193' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Get <em>ConnectionInfo</em> for the correct request.</p>
|
|||
|
|
</div><h4 id='method.stream_extensions' class="method"><span id='stream_extensions.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.stream_extensions' class='fnname'>stream_extensions</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="struct" href="../../actix_web/struct.Extensions.html" title="struct actix_web::Extensions">Extensions</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/message.rs.html#197-199' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Io stream extensions</p>
|
|||
|
|
</div><h4 id='method.server_settings' class="method"><span id='server_settings.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.server_settings' class='fnname'>server_settings</a>(&self) -> &<a class="struct" href="../../actix_web/server/struct.ServerSettings.html" title="struct actix_web::server::ServerSettings">ServerSettings</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/message.rs.html#203-205' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Server settings</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-HttpMessage' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../../actix_web/trait.HttpMessage.html" title="trait actix_web::HttpMessage">HttpMessage</a> for <a class="struct" href="../../actix_web/struct.Request.html" title="struct actix_web::Request">Request</a></code><a href='#impl-HttpMessage' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/message.rs.html#54-69' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Stream' class="type"><span id='Stream.t' class='invisible'><code>type <a href='../../actix_web/trait.HttpMessage.html#associatedtype.Stream' class="type">Stream</a> = <a class="struct" href="../../actix_web/dev/struct.Payload.html" title="struct actix_web::dev::Payload">Payload</a></code></span></h4>
|
|||
|
|
<div class='docblock'><p>Type of message payload stream</p>
|
|||
|
|
</div><h4 id='method.headers-1' class="method"><span id='headers.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/trait.HttpMessage.html#tymethod.headers' class='fnname'>headers</a>(&self) -> &<a class="struct" href="../../actix_web/http/header/struct.HeaderMap.html" title="struct actix_web::http::header::HeaderMap">HeaderMap</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/message.rs.html#57-59' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Read the message headers.</p>
|
|||
|
|
</div><h4 id='method.payload' class="method"><span id='payload.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/trait.HttpMessage.html#tymethod.payload' class='fnname'>payload</a>(&self) -> <a class="struct" href="../../actix_web/dev/struct.Payload.html" title="struct actix_web::dev::Payload">Payload</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/server/message.rs.html#62-68' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Message payload stream</p>
|
|||
|
|
</div><h4 id='method.content_type' class="method"><span id='content_type.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/trait.HttpMessage.html#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></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/httpmessage.rs.html#46-53' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Read the request content type. If request does not contain Content-Type header, empty str get returned. <a href="../../actix_web/trait.HttpMessage.html#method.content_type">Read more</a></p>
|
|||
|
|
</div><h4 id='method.encoding' class="method"><span id='encoding.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/trait.HttpMessage.html#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><EncodingRef, <a class="enum" href="../../actix_web/error/enum.ContentTypeError.html" title="enum actix_web::error::ContentTypeError">ContentTypeError</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/httpmessage.rs.html#58-72' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Get content type encoding <a href="../../actix_web/trait.HttpMessage.html#method.encoding">Read more</a></p>
|
|||
|
|
</div><h4 id='method.mime_type' class="method"><span id='mime_type.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/trait.HttpMessage.html#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="https://docs.rs/mime/0.3.9/mime/struct.Mime.html" title="struct mime::Mime">Mime</a>>, <a class="enum" href="../../actix_web/error/enum.ContentTypeError.html" title="enum actix_web::error::ContentTypeError">ContentTypeError</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/httpmessage.rs.html#75-87' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Convert the request content type to a known mime type.</p>
|
|||
|
|
</div><h4 id='method.chunked' class="method"><span id='chunked.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/trait.HttpMessage.html#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_web/error/enum.ParseError.html" title="enum actix_web::error::ParseError">ParseError</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/httpmessage.rs.html#90-100' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Check if request has chunked transfer encoding</p>
|
|||
|
|
</div><h4 id='method.body' class="method"><span id='body.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/trait.HttpMessage.html#method.body' class='fnname'>body</a>(&self) -> <a class="struct" href="../../actix_web/dev/struct.MessageBody.html" title="struct actix_web::dev::MessageBody">MessageBody</a><Self></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/httpmessage.rs.html#132-134' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Load http message body. <a href="../../actix_web/trait.HttpMessage.html#method.body">Read more</a></p>
|
|||
|
|
</div><h4 id='method.urlencoded' class="method"><span id='urlencoded.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/trait.HttpMessage.html#method.urlencoded' class='fnname'>urlencoded</a><T: <a class="trait" href="https://docs.rs/serde/1.0.79/serde/de/trait.DeserializeOwned.html" title="trait serde::de::DeserializeOwned">DeserializeOwned</a>>(&self) -> <a class="struct" href="../../actix_web/dev/struct.UrlEncoded.html" title="struct actix_web::dev::UrlEncoded">UrlEncoded</a><Self, T></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/httpmessage.rs.html#166-168' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Parse <code>application/x-www-form-urlencoded</code> encoded request's body. Return <code>UrlEncoded</code> future. Form can be deserialized to any type that implements <code>Deserialize</code> trait from serde. <a href="../../actix_web/trait.HttpMessage.html#method.urlencoded">Read more</a></p>
|
|||
|
|
</div><h4 id='method.json' class="method"><span id='json.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/trait.HttpMessage.html#method.json' class='fnname'>json</a><T: <a class="trait" href="https://docs.rs/serde/1.0.79/serde/de/trait.DeserializeOwned.html" title="trait serde::de::DeserializeOwned">DeserializeOwned</a>>(&self) -> <a class="struct" href="../../actix_web/dev/struct.JsonBody.html" title="struct actix_web::dev::JsonBody">JsonBody</a><Self, T></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/httpmessage.rs.html#202-204' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Parse <code>application/json</code> encoded body. Return <code>JsonBody<T></code> future. It resolves to a <code>T</code> value. <a href="../../actix_web/trait.HttpMessage.html#method.json">Read more</a></p>
|
|||
|
|
</div><h4 id='method.multipart' class="method"><span id='multipart.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/trait.HttpMessage.html#method.multipart' class='fnname'>multipart</a>(&self) -> <a class="struct" href="../../actix_web/multipart/struct.Multipart.html" title="struct actix_web::multipart::Multipart">Multipart</a><Self::<a class="type" href="../../actix_web/trait.HttpMessage.html#associatedtype.Stream" title="type actix_web::HttpMessage::Stream">Stream</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/httpmessage.rs.html#241-244' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Return stream to http payload processes as multipart. <a href="../../actix_web/trait.HttpMessage.html#method.multipart">Read more</a></p>
|
|||
|
|
</div><h4 id='method.readlines' class="method"><span id='readlines.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/trait.HttpMessage.html#method.readlines' class='fnname'>readlines</a>(&self) -> <a class="struct" href="../../actix_web/dev/struct.Readlines.html" title="struct actix_web::dev::Readlines">Readlines</a><Self></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/httpmessage.rs.html#247-249' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Return stream of lines.</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="../../actix_web/struct.Request.html" title="struct actix_web::Request">Request</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/actix_web/server/message.rs.html#224-242' 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/actix_web/server/message.rs.html#225-241' 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></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 !<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="../../actix_web/struct.Request.html" title="struct actix_web::Request">Request</a></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 !<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="../../actix_web/struct.Request.html" title="struct actix_web::Request">Request</a></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><h2 id='blanket-implementations' class='small-section-header'>Blanket Implementations<a href='#blanket-implementations' class='anchor'></a></h2><div id='blanket-implementations-list'><h3 id='impl-From' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a> for T</code><a href='#impl-From' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#462-464' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.from' class="method"><span id='from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(t: T) -> T</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#463' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
|
|||
|
|
</div></div><h3 id='impl-Into' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href='#impl-Into' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#453-458' 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) -> U</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#455-457' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
|
|||
|
|
</div></div><h3 id='impl-TryFrom' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><U>, </span></code><a href='#impl-TryFrom' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#481-487' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Error' class="type"><span id='Error.t' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error' class="type">Error</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.never.html">!</a></code></span></h4>
|
|||
|
|
<div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>try_from</code>)</div></div><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
|||
|
|
</div><h4 id='method.try_from' class="method"><span id='try_from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from' class='fnname'>try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#484-486' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>try_from</code>)</div></div><div class='docblock'><p>Performs the conversion.</p>
|
|||
|
|
</div></div><h3 id='impl-Borrow' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Borrow' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#219-221' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.borrow' class="method"><span id='borrow.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow' class='fnname'>borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#220' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
|||
|
|
</div></div><h3 id='impl-BorrowMut' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-BorrowMut' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#224-226' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.borrow_mut' class="method"><span id='borrow_mut.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut' class='fnname'>borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#225' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
|||
|
|
</div></div><h3 id='impl-TryInto' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href='#impl-TryInto' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#469-476' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Error-1' class="type"><span id='Error.t-1' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error' class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></span></h4>
|
|||
|
|
<div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>try_from</code>)</div></div><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
|||
|
|
</div><h4 id='method.try_into' class="method"><span id='try_into.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into' class='fnname'>try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#473-475' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>try_from</code>)</div></div><div class='docblock'><p>Performs the conversion.</p>
|
|||
|
|
</div></div><h3 id='impl-Any' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Any' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#114-116' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.get_type_id' class="method"><span id='get_type_id.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.get_type_id' class='fnname'>get_type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#115' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='stability'><div class='stab unstable'><details><summary><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>get_type_id</code>)</summary><p>this method will likely be replaced by an associated static</p>
|
|||
|
|
</details></div></div><div class='docblock'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.get_type_id">Read more</a></p>
|
|||
|
|
</div></div><h3 id='impl-Erased' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<T> Erased for T</code><a href='#impl-Erased' 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><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "actix_web";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
|