<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="API documentation for the Rust `Request` struct in crate `actix_web`."><metaname="keywords"content="rust, rustlang, rust-lang, Request"><title>actix_web::Request - Rust</title><linkrel="stylesheet"type="text/css"href="../normalize.css"><linkrel="stylesheet"type="text/css"href="../rustdoc.css"id="mainThemeStyle"><linkrel="stylesheet"type="text/css"href="../dark.css"><linkrel="stylesheet"type="text/css"href="../light.css"id="themeStyle"><scriptsrc="../storage.js"></script></head><bodyclass="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="sidebar"><divclass="sidebar-menu">☰</div><pclass='location'>Struct Request</p><divclass="sidebar-elems"><divclass="block items"><aclass="sidebar-title"href="#methods">Methods</a><divclass="sidebar-links"><ahref="#method.uri">uri</a><ahref="#method.method">method</a><ahref="#method.version">version</a><ahref="#method.path">path</a><ahref="#method.headers">headers</a><ahref="#method.headers_mut">headers_mut</a><ahref="#method.peer_addr">peer_addr</a><ahref="#method.keep_alive">keep_alive</a><ahref="#method.extensions">extensions</a><ahref="#method.extensions_mut">extensions_mut</a><ahref="#method.upgrade">upgrade</a><ahref="#method.connection_info">connection_info</a><ahref="#method.server_settings">server_settings</a></div><aclass="sidebar-title"href="#implementations">Trait Implementations</a><divclass="sidebar-links"><ahref="#impl-HttpMessage">HttpMessage</a></div><aclass="sidebar-title"href="#synthetic-implementations">Auto Trait Implementations</a><divclass="sidebar-links"><ahref="#impl-Send">!Send</a><ahref="#impl-Sync">!Sync</a></div></div><pclass='location'><ahref='index.html'>actix_web</a></p><script>window.sidebarCurrent={name:'Request',ty:'struct',relpath:''};</script><scriptdefersrc="sidebar-items.js"></script></div></nav><divclass="theme-picker"><buttonid="theme-picker"aria-label="Pick another theme!"><imgsrc="../brush.svg"width="18"alt="Pick another theme!"></button><divid="theme-choices"></div></div><scriptsrc="../theme.js"></script><navclass="sub"><formclass="search-form js-only"><divclass="search-container"><inputclass="search-input"name="search"autocomplete="off"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"><aid="settings-menu"href="../settings.html"><imgsrc="../wheel.svg"width="18"alt="Change settings"></a></div></form></nav><sectionid="main"class="content"><h1class='fqn'><spanclass='in-band'>Struct <ahref='index.html'>actix_web</a>::<wbr><aclass="struct"href=''>Request</a></span><spanclass='out-of-band'><spanid='render-detail'><aid="toggle-all-docs"href="javascript:void(0)"title="collapse all docs">[<spanclass='inner'>−</span>]</a></span><aclass='srclink'href='../src/actix_web/server/message.rs.html#23-25'title='goto source code'>[src]</a></span></h1><divclass="docblock type-decl"><preclass='rust struct'>pub struct Request { /* fields omitted */ }</pre></div><divclass='docblock'><p>Request's context</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><h4id='method.keep_alive'class="method"><spanid='keep_alive.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>pub fn <ahref='#method.keep_alive'class='fnname'>keep_alive</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='../src/actix_web/server/message.rs.html#153-155'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>Checks if a connection should be kept alive.</p>
</div><h4id='method.extensions_mut'class="method"><spanid='extensions_mut.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>pub fn <ahref='#method.extensions_mut'class='fnname'>extensions_mut</a>(&self) -><aclass="struct"href="https://doc.rust-lang.org/nightly/core/cell/struct.RefMut.html"title="struct core::cell::RefMut">RefMut</a><<aclass="struct"href="../actix_web/struct.Extensions.html"title="struct actix_web::Extensions">Extensions</a>></code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='../src/actix_web/server/message.rs.html#165-167'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>Mutable reference to a the request's extensions</p>
</div><h4id='method.content_type'class="method"><spanid='content_type.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>fn <ahref='../actix_web/trait.HttpMessage.html#method.content_type'class='fnname'>content_type</a>(&self) ->&<aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='../src/actix_web/httpmessage.rs.html#46-53'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>Read the request content type. If request does not contain Content-Type header, empty str get returned. <ahref="../actix_web/trait.HttpMessage.html#method.content_type">Read more</a></p>
</div><h4id='method.mime_type'class="method"><spanid='mime_type.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>fn <ahref='../actix_web/trait.HttpMessage.html#method.mime_type'class='fnname'>mime_type</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="enum"href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html"title="enum core::option::Option">Option</a><<aclass="struct"href="https://docs.rs/mime/0.3.8/mime/struct.Mime.html"title="struct mime::Mime">Mime</a>>, <aclass="enum"href="../actix_web/error/enum.ContentTypeError.html"title="enum actix_web::error::ContentTypeError">ContentTypeError</a>></code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='../src/actix_web/httpmessage.rs.html#75-87'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>Convert the request content type to a known mime type.</p>
</div><h4id='method.chunked'class="method"><spanid='chunked.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>fn <ahref='../actix_web/trait.HttpMessage.html#method.chunked'class='fnname'>chunked</a>(&self) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><<aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, <aclass="enum"href="../actix_web/error/enum.ParseError.html"title="enum actix_web::error::ParseError">ParseError</a>></code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='../src/actix_web/httpmessage.rs.html#90-100'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>Check if request has chunked transfer encoding</p>
</div><h4id='method.urlencoded'class="method"><spanid='urlencoded.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>fn <ahref='../actix_web/trait.HttpMessage.html#method.urlencoded'class='fnname'>urlencoded</a><T: <aclass="trait"href="https://docs.rs/serde/1.0.70/serde/de/trait.DeserializeOwned.html"title="trait serde::de::DeserializeOwned">DeserializeOwned</a>>(&self) -><aclass="struct"href="../actix_web/dev/struct.UrlEncoded.html"title="struct actix_web::dev::UrlEncoded">UrlEncoded</a><Self, T></code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='../src/actix_web/httpmessage.rs.html#166-168'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='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. <ahref="../actix_web/trait.HttpMessage.html#method.urlencoded">Read more</a></p>
</div><h4id='method.json'class="method"><spanid='json.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>fn <ahref='../actix_web/trait.HttpMessage.html#method.json'class='fnname'>json</a><T: <aclass="trait"href="https://docs.rs/serde/1.0.70/serde/de/trait.DeserializeOwned.html"title="trait serde::de::DeserializeOwned">DeserializeOwned</a>>(&self) -><aclass="struct"href="../actix_web/dev/struct.JsonBody.html"title="struct actix_web::dev::JsonBody">JsonBody</a><Self, T></code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='../src/actix_web/httpmessage.rs.html#202-204'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>Parse <code>application/json</code> encoded body. Return <code>JsonBody<T></code> future. It resolves to a <code>T</code> value. <ahref="../actix_web/trait.HttpMessage.html#method.json">Read more</a></p>
</div><h4id='method.multipart'class="method"><spanid='multipart.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>fn <ahref='../actix_web/trait.HttpMessage.html#method.multipart'class='fnname'>multipart</a>(&self) -><aclass="struct"href="../actix_web/multipart/struct.Multipart.html"title="struct actix_web::multipart::Multipart">Multipart</a><Self::<aclass="type"href="../actix_web/trait.HttpMessage.html#associatedtype.Stream"title="type actix_web::HttpMessage::Stream">Stream</a>></code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='../src/actix_web/httpmessage.rs.html#241-244'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>Return stream to http payload processes as multipart. <ahref="../actix_web/trait.HttpMessage.html#method.multipart">Read more</a></p>
</div><h4id='method.readlines'class="method"><spanid='readlines.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>fn <ahref='../actix_web/trait.HttpMessage.html#method.readlines'class='fnname'>readlines</a>(&self) -> Readlines<Self></code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='../src/actix_web/httpmessage.rs.html#247-249'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>Return stream of lines.</p>
Auto Trait Implementations<ahref='#synthetic-implementations'class='anchor'></a>
</h2>
<divid='synthetic-implementations-list'>
<h3id='impl-Send'class='impl'><spanclass='in-band'><tableclass='table-display'><tbody><tr><td><code>impl !<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html"title="trait core::marker::Send">Send</a> for <aclass="struct"href="../actix_web/struct.Request.html"title="struct actix_web::Request">Request</a></code><ahref='#impl-Send'class='anchor'></a></span></td><td><spanclass='out-of-band'></span></td></tr></tbody></table></h3><divclass='impl-items'></div><h3id='impl-Sync'class='impl'><spanclass='in-band'><tableclass='table-display'><tbody><tr><td><code>impl !<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html"title="trait core::marker::Sync">Sync</a> for <aclass="struct"href="../actix_web/struct.Request.html"title="struct actix_web::Request">Request</a></code><ahref='#impl-Sync'class='anchor'></a></span></td><td><spanclass='out-of-band'></span></td></tr></tbody></table></h3><divclass='impl-items'></div></div></section><sectionid="search"class="content hidden"></section><sectionclass="footer"></section><asideid="help"class="hidden"><div><h1class="hidden">Help</h1><divclass="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><divclass="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><scriptsrc="../aliases.js"></script><scriptsrc="../main.js"></script><scriptdefersrc="../search-index.js"></script></body></html>
