mirror of
https://github.com/actix/actix-website
synced 2024-12-18 18:03:12 +01:00
232 lines
61 KiB
HTML
232 lines
61 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 `App` struct in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, App"><title>actix_web::App - 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 App</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.with_state">with_state</a><a href="#method.state">state</a><a href="#method.prefix">prefix</a><a href="#method.filter">filter</a><a href="#method.route">route</a><a href="#method.scope">scope</a><a href="#method.resource">resource</a><a href="#method.default_resource">default_resource</a><a href="#method.default_encoding">default_encoding</a><a href="#method.external_resource">external_resource</a><a href="#method.handler">handler</a><a href="#method.middleware">middleware</a><a href="#method.configure">configure</a><a href="#method.finish">finish</a><a href="#method.boxed">boxed</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-IntoHttpHandler">IntoHttpHandler</a><a href="#impl-Default">Default</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-IntoIterator">IntoIterator</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></p><script>window.sidebarCurrent = {name: 'App', 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/application.rs.html#105-107' title='goto source code'>[src]</a></span><span class='in-band'>Struct <a href='index.html'>actix_web</a>::<wbr><a class="struct" href=''>App</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust struct'>pub struct App<S = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>> { /* fields omitted */ }</pre></div><div class='docblock'><p>Structure that follows the builder pattern for building application
|
|||
|
|
instances.</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.App.html" title="struct actix_web::App">App</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</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/application.rs.html#109-115' 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="../actix_web/struct.App.html" title="struct actix_web::App">App</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/actix_web/application.rs.html#112-114' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create application with empty state. Application can
|
|||
|
|
be configured with a builder-like pattern.</p>
|
|||
|
|
</div></div><h3 id='impl-1' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<S> <a class="struct" href="../actix_web/struct.App.html" title="struct actix_web::App">App</a><S> <span class="where fmt-newline">where<br> S: 'static, </span></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/actix_web/application.rs.html#123-566' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.with_state' class="method"><span id='with_state.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.with_state' class='fnname'>with_state</a>(state: S) -> <a class="struct" href="../actix_web/struct.App.html" title="struct actix_web::App">App</a><S></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/actix_web/application.rs.html#139-150' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create application with specified state. Application can be
|
|||
|
|
configured with a builder-like pattern.</p>
|
|||
|
|
<p>State is shared with all resources within same application and
|
|||
|
|
could be accessed with <code>HttpRequest::state()</code> method.</p>
|
|||
|
|
<p><strong>Note</strong>: http server accepts an application factory rather than
|
|||
|
|
an application instance. Http server constructs an application
|
|||
|
|
instance for each thread, thus application state must be constructed
|
|||
|
|
multiple times. If you want to share state between different
|
|||
|
|
threads, a shared object should be used, e.g. <code>Arc</code>. Application
|
|||
|
|
state does not need to be <code>Send</code> or <code>Sync</code>.</p>
|
|||
|
|
</div><h4 id='method.state' class="method"><span id='state.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.state' class='fnname'>state</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>S</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/actix_web/application.rs.html#153-156' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Get reference to the application state</p>
|
|||
|
|
</div><h4 id='method.prefix' class="method"><span id='prefix.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.prefix' class='fnname'>prefix</a><P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>>(self, prefix: P) -> <a class="struct" href="../actix_web/struct.App.html" title="struct actix_web::App">App</a><S></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/actix_web/application.rs.html#195-206' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set application prefix.</p>
|
|||
|
|
<p>Only requests that match the application's prefix get
|
|||
|
|
processed by this application.</p>
|
|||
|
|
<p>The application prefix always contains a leading slash (<code>/</code>).
|
|||
|
|
If the supplied prefix does not contain leading slash, it is
|
|||
|
|
inserted.</p>
|
|||
|
|
<p>Prefix should consist of valid path segments. i.e for an
|
|||
|
|
application with the prefix <code>/app</code> any request with the paths
|
|||
|
|
<code>/app</code>, <code>/app/</code> or <code>/app/test</code> would match, but the path
|
|||
|
|
<code>/application</code> would not.</p>
|
|||
|
|
<p>In the following example only requests with an <code>/app/</code> path
|
|||
|
|
prefix get handled. Requests with path <code>/app/test/</code> would be
|
|||
|
|
handled, while requests with the paths <code>/application</code> or
|
|||
|
|
<code>/other/...</code> would return <code>NOT FOUND</code>. It is also possible to
|
|||
|
|
handle <code>/app</code> path, to do this you can register resource for
|
|||
|
|
empty string <code>""</code></p>
|
|||
|
|
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">http</span>, <span class="ident">App</span>, <span class="ident">HttpResponse</span>};
|
|||
|
|
|
|||
|
|
<span class="kw">fn</span> <span class="ident">main</span>() {
|
|||
|
|
<span class="kw">let</span> <span class="ident">app</span> <span class="op">=</span> <span class="ident">App</span>::<span class="ident">new</span>()
|
|||
|
|
.<span class="ident">prefix</span>(<span class="string">"/app"</span>)
|
|||
|
|
.<span class="ident">resource</span>(<span class="string">""</span>, <span class="op">|</span><span class="ident">r</span><span class="op">|</span> <span class="ident">r</span>.<span class="ident">f</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>())) <span class="comment">// <- handle `/app` path</span>
|
|||
|
|
.<span class="ident">resource</span>(<span class="string">"/"</span>, <span class="op">|</span><span class="ident">r</span><span class="op">|</span> <span class="ident">r</span>.<span class="ident">f</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>())) <span class="comment">// <- handle `/app/` path</span>
|
|||
|
|
.<span class="ident">resource</span>(<span class="string">"/test"</span>, <span class="op">|</span><span class="ident">r</span><span class="op">|</span> {
|
|||
|
|
<span class="ident">r</span>.<span class="ident">get</span>().<span class="ident">f</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>());
|
|||
|
|
<span class="ident">r</span>.<span class="ident">head</span>().<span class="ident">f</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="ident">HttpResponse</span>::<span class="ident">MethodNotAllowed</span>());
|
|||
|
|
})
|
|||
|
|
.<span class="ident">finish</span>();
|
|||
|
|
}</pre>
|
|||
|
|
</div><h4 id='method.filter' class="method"><span id='filter.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.filter' class='fnname'>filter</a><T: <a class="trait" href="../actix_web/pred/trait.Predicate.html" title="trait actix_web::pred::Predicate">Predicate</a><S> + 'static>(self, p: T) -> <a class="struct" href="../actix_web/struct.App.html" title="struct actix_web::App">App</a><S></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/actix_web/application.rs.html#220-226' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Add match predicate to application.</p>
|
|||
|
|
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="ident">App</span>::<span class="ident">new</span>()
|
|||
|
|
.<span class="ident">filter</span>(<span class="ident">pred</span>::<span class="ident">Host</span>(<span class="string">"www.rust-lang.org"</span>))
|
|||
|
|
.<span class="ident">resource</span>(<span class="string">"/path"</span>, <span class="op">|</span><span class="ident">r</span><span class="op">|</span> <span class="ident">r</span>.<span class="ident">f</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>()))</pre>
|
|||
|
|
</div><h4 id='method.route' class="method"><span id='route.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.route' class='fnname'>route</a><T, F, R>(self, path: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, method: <a class="struct" href="../actix_web/http/struct.Method.html" title="struct actix_web::http::Method">Method</a>, f: F) -> <a class="struct" href="../actix_web/struct.App.html" title="struct actix_web::App">App</a><S> <span class="where fmt-newline">where<br> F: WithFactory<T, S, R>,<br> R: <a class="trait" href="../actix_web/trait.Responder.html" title="trait actix_web::Responder">Responder</a> + 'static,<br> T: <a class="trait" href="../actix_web/trait.FromRequest.html" title="trait actix_web::FromRequest">FromRequest</a><S> + 'static, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/actix_web/application.rs.html#251-264' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Configure route for a specific path.</p>
|
|||
|
|
<p>This is a simplified version of the <code>App::resource()</code> method.
|
|||
|
|
Handler functions need to accept one request extractor
|
|||
|
|
argument.</p>
|
|||
|
|
<p>This method could be called multiple times, in that case
|
|||
|
|
multiple routes would be registered for same resource path.</p>
|
|||
|
|
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">http</span>, <span class="ident">App</span>, <span class="ident">HttpRequest</span>, <span class="ident">HttpResponse</span>};
|
|||
|
|
|
|||
|
|
<span class="kw">fn</span> <span class="ident">main</span>() {
|
|||
|
|
<span class="kw">let</span> <span class="ident">app</span> <span class="op">=</span> <span class="ident">App</span>::<span class="ident">new</span>()
|
|||
|
|
.<span class="ident">route</span>(<span class="string">"/test"</span>, <span class="ident">http</span>::<span class="ident">Method</span>::<span class="ident">GET</span>, <span class="op">|</span><span class="kw">_</span>: <span class="ident">HttpRequest</span><span class="op">|</span> {
|
|||
|
|
<span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>()
|
|||
|
|
})
|
|||
|
|
.<span class="ident">route</span>(<span class="string">"/test"</span>, <span class="ident">http</span>::<span class="ident">Method</span>::<span class="ident">POST</span>, <span class="op">|</span><span class="kw">_</span>: <span class="ident">HttpRequest</span><span class="op">|</span> {
|
|||
|
|
<span class="ident">HttpResponse</span>::<span class="ident">MethodNotAllowed</span>()
|
|||
|
|
});
|
|||
|
|
}</pre>
|
|||
|
|
</div><h4 id='method.scope' class="method"><span id='scope.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.scope' class='fnname'>scope</a><F>(self, path: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, f: F) -> <a class="struct" href="../actix_web/struct.App.html" title="struct actix_web::App">App</a><S> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="struct" href="../actix_web/struct.Scope.html" title="struct actix_web::Scope">Scope</a><S>) -> <a class="struct" href="../actix_web/struct.Scope.html" title="struct actix_web::Scope">Scope</a><S>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/actix_web/application.rs.html#290-301' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Configure scope for common root path.</p>
|
|||
|
|
<p>Scopes collect multiple paths under a common path prefix.
|
|||
|
|
Scope path can contain variable path segments as resources.</p>
|
|||
|
|
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">http</span>, <span class="ident">App</span>, <span class="ident">HttpRequest</span>, <span class="ident">HttpResponse</span>};
|
|||
|
|
|
|||
|
|
<span class="kw">fn</span> <span class="ident">main</span>() {
|
|||
|
|
<span class="kw">let</span> <span class="ident">app</span> <span class="op">=</span> <span class="ident">App</span>::<span class="ident">new</span>().<span class="ident">scope</span>(<span class="string">"/{project_id}"</span>, <span class="op">|</span><span class="ident">scope</span><span class="op">|</span> {
|
|||
|
|
<span class="ident">scope</span>
|
|||
|
|
.<span class="ident">resource</span>(<span class="string">"/path1"</span>, <span class="op">|</span><span class="ident">r</span><span class="op">|</span> <span class="ident">r</span>.<span class="ident">f</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>()))
|
|||
|
|
.<span class="ident">resource</span>(<span class="string">"/path2"</span>, <span class="op">|</span><span class="ident">r</span><span class="op">|</span> <span class="ident">r</span>.<span class="ident">f</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>()))
|
|||
|
|
.<span class="ident">resource</span>(<span class="string">"/path3"</span>, <span class="op">|</span><span class="ident">r</span><span class="op">|</span> <span class="ident">r</span>.<span class="ident">f</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="ident">HttpResponse</span>::<span class="ident">MethodNotAllowed</span>()))
|
|||
|
|
});
|
|||
|
|
}</pre>
|
|||
|
|
<p>In the above example, three routes get added:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li>/{project_id}/path1</li>
|
|||
|
|
<li>/{project_id}/path2</li>
|
|||
|
|
<li>/{project_id}/path3</li>
|
|||
|
|
</ul>
|
|||
|
|
</div><h4 id='method.resource' class="method"><span id='resource.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.resource' class='fnname'>resource</a><F, R>(self, path: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, f: F) -> <a class="struct" href="../actix_web/struct.App.html" title="struct actix_web::App">App</a><S> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(&mut <a class="struct" href="../actix_web/dev/struct.Resource.html" title="struct actix_web::dev::Resource">Resource</a><S>) -> R + 'static, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/actix_web/application.rs.html#334-350' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Configure resource for a specific path.</p>
|
|||
|
|
<p>Resources may have variable path segments. For example, a
|
|||
|
|
resource with the path <code>/a/{name}/c</code> would match all incoming
|
|||
|
|
requests with paths such as <code>/a/b/c</code>, <code>/a/1/c</code>, or <code>/a/etc/c</code>.</p>
|
|||
|
|
<p>A variable segment is specified in the form <code>{identifier}</code>,
|
|||
|
|
where the identifier can be used later in a request handler to
|
|||
|
|
access the matched value for that segment. This is done by
|
|||
|
|
looking up the identifier in the <code>Params</code> object returned by
|
|||
|
|
<code>HttpRequest.match_info()</code> method.</p>
|
|||
|
|
<p>By default, each segment matches the regular expression <code>[^{}/]+</code>.</p>
|
|||
|
|
<p>You can also specify a custom regex in the form <code>{identifier:regex}</code>:</p>
|
|||
|
|
<p>For instance, to route <code>GET</code>-requests on any route matching
|
|||
|
|
<code>/users/{userid}/{friend}</code> and store <code>userid</code> and <code>friend</code> in
|
|||
|
|
the exposed <code>Params</code> object:</p>
|
|||
|
|
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">http</span>, <span class="ident">App</span>, <span class="ident">HttpResponse</span>};
|
|||
|
|
|
|||
|
|
<span class="kw">fn</span> <span class="ident">main</span>() {
|
|||
|
|
<span class="kw">let</span> <span class="ident">app</span> <span class="op">=</span> <span class="ident">App</span>::<span class="ident">new</span>().<span class="ident">resource</span>(<span class="string">"/users/{userid}/{friend}"</span>, <span class="op">|</span><span class="ident">r</span><span class="op">|</span> {
|
|||
|
|
<span class="ident">r</span>.<span class="ident">get</span>().<span class="ident">f</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>());
|
|||
|
|
<span class="ident">r</span>.<span class="ident">head</span>().<span class="ident">f</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="ident">HttpResponse</span>::<span class="ident">MethodNotAllowed</span>());
|
|||
|
|
});
|
|||
|
|
}</pre>
|
|||
|
|
</div><h4 id='method.default_resource' class="method"><span id='default_resource.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.default_resource' class='fnname'>default_resource</a><F, R>(self, f: F) -> <a class="struct" href="../actix_web/struct.App.html" title="struct actix_web::App">App</a><S> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(&mut <a class="struct" href="../actix_web/dev/struct.Resource.html" title="struct actix_web::dev::Resource">Resource</a><S>) -> R + 'static, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/actix_web/application.rs.html#363-378' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Default resource to be used if no matching route could be found.</p>
|
|||
|
|
</div><h4 id='method.default_encoding' class="method"><span id='default_encoding.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.default_encoding' class='fnname'>default_encoding</a>(self, encoding: <a class="enum" href="../actix_web/http/enum.ContentEncoding.html" title="enum actix_web::http::ContentEncoding">ContentEncoding</a>) -> <a class="struct" href="../actix_web/struct.App.html" title="struct actix_web::App">App</a><S></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/actix_web/application.rs.html#381-387' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set default content encoding. <code>ContentEncoding::Auto</code> is set by default.</p>
|
|||
|
|
</div><h4 id='method.external_resource' class="method"><span id='external_resource.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.external_resource' class='fnname'>external_resource</a><T, U>(self, name: T, url: U) -> <a class="struct" href="../actix_web/struct.App.html" title="struct actix_web::App">App</a><S> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>,<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/actix_web/application.rs.html#412-423' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Register an external resource.</p>
|
|||
|
|
<p>External resources are useful for URL generation purposes only
|
|||
|
|
and are never considered for matching at request time. Calls to
|
|||
|
|
<code>HttpRequest::url_for()</code> will work as expected.</p>
|
|||
|
|
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">App</span>, <span class="ident">HttpRequest</span>, <span class="ident">HttpResponse</span>, <span class="prelude-ty">Result</span>};
|
|||
|
|
|
|||
|
|
<span class="kw">fn</span> <span class="ident">index</span>(<span class="ident">req</span>: <span class="kw-2">&</span><span class="ident">HttpRequest</span>) <span class="op">-></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">HttpResponse</span><span class="op">></span> {
|
|||
|
|
<span class="kw">let</span> <span class="ident">url</span> <span class="op">=</span> <span class="ident">req</span>.<span class="ident">url_for</span>(<span class="string">"youtube"</span>, <span class="kw-2">&</span>[<span class="string">"oHg5SJYRHA0"</span>])<span class="question-mark">?</span>;
|
|||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">url</span>.<span class="ident">as_str</span>(), <span class="string">"https://youtube.com/watch/oHg5SJYRHA0"</span>);
|
|||
|
|
<span class="prelude-val">Ok</span>(<span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>().<span class="ident">into</span>())
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
<span class="kw">fn</span> <span class="ident">main</span>() {
|
|||
|
|
<span class="kw">let</span> <span class="ident">app</span> <span class="op">=</span> <span class="ident">App</span>::<span class="ident">new</span>()
|
|||
|
|
.<span class="ident">resource</span>(<span class="string">"/index.html"</span>, <span class="op">|</span><span class="ident">r</span><span class="op">|</span> <span class="ident">r</span>.<span class="ident">get</span>().<span class="ident">f</span>(<span class="ident">index</span>))
|
|||
|
|
.<span class="ident">external_resource</span>(<span class="string">"youtube"</span>, <span class="string">"https://youtube.com/watch/{video_id}"</span>)
|
|||
|
|
.<span class="ident">finish</span>();
|
|||
|
|
}</pre>
|
|||
|
|
</div><h4 id='method.handler' class="method"><span id='handler.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.handler' class='fnname'>handler</a><H: <a class="trait" href="../actix_web/dev/trait.Handler.html" title="trait actix_web::dev::Handler">Handler</a><S>>(self, path: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, handler: H) -> <a class="struct" href="../actix_web/struct.App.html" title="struct actix_web::App">App</a><S></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/actix_web/application.rs.html#446-459' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Configure handler for specific path prefix.</p>
|
|||
|
|
<p>A path prefix consists of valid path segments, i.e for the
|
|||
|
|
prefix <code>/app</code> any request with the paths <code>/app</code>, <code>/app/</code> or
|
|||
|
|
<code>/app/test</code> would match, but the path <code>/application</code> would
|
|||
|
|
not.</p>
|
|||
|
|
<p>Path tail is available as <code>tail</code> parameter in request's match_dict.</p>
|
|||
|
|
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">http</span>, <span class="ident">App</span>, <span class="ident">HttpRequest</span>, <span class="ident">HttpResponse</span>};
|
|||
|
|
|
|||
|
|
<span class="kw">fn</span> <span class="ident">main</span>() {
|
|||
|
|
<span class="kw">let</span> <span class="ident">app</span> <span class="op">=</span> <span class="ident">App</span>::<span class="ident">new</span>().<span class="ident">handler</span>(<span class="string">"/app"</span>, <span class="op">|</span><span class="ident">req</span>: <span class="kw-2">&</span><span class="ident">HttpRequest</span><span class="op">|</span> <span class="kw">match</span> <span class="kw-2">*</span><span class="ident">req</span>.<span class="ident">method</span>() {
|
|||
|
|
<span class="ident">http</span>::<span class="ident">Method</span>::<span class="ident">GET</span> <span class="op">=></span> <span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>(),
|
|||
|
|
<span class="ident">http</span>::<span class="ident">Method</span>::<span class="ident">POST</span> <span class="op">=></span> <span class="ident">HttpResponse</span>::<span class="ident">MethodNotAllowed</span>(),
|
|||
|
|
<span class="kw">_</span> <span class="op">=></span> <span class="ident">HttpResponse</span>::<span class="ident">NotFound</span>(),
|
|||
|
|
});
|
|||
|
|
}</pre>
|
|||
|
|
</div><h4 id='method.middleware' class="method"><span id='middleware.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.middleware' class='fnname'>middleware</a><M: <a class="trait" href="../actix_web/middleware/trait.Middleware.html" title="trait actix_web::middleware::Middleware">Middleware</a><S>>(self, mw: M) -> <a class="struct" href="../actix_web/struct.App.html" title="struct actix_web::App">App</a><S></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/actix_web/application.rs.html#462-469' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Register a middleware.</p>
|
|||
|
|
</div><h4 id='method.configure' class="method"><span id='configure.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.configure' class='fnname'>configure</a><F>(self, cfg: F) -> <a class="struct" href="../actix_web/struct.App.html" title="struct actix_web::App">App</a><S> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(<a class="struct" href="../actix_web/struct.App.html" title="struct actix_web::App">App</a><S>) -> <a class="struct" href="../actix_web/struct.App.html" title="struct actix_web::App">App</a><S>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/actix_web/application.rs.html#497-502' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Run external configuration as part of the application building
|
|||
|
|
process</p>
|
|||
|
|
<p>This function is useful for moving parts of configuration to a
|
|||
|
|
different module or event library. For example we can move
|
|||
|
|
some of the resources' configuration to different module.</p>
|
|||
|
|
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">fs</span>, <span class="ident">middleware</span>, <span class="ident">App</span>, <span class="ident">HttpResponse</span>};
|
|||
|
|
|
|||
|
|
<span class="comment">// this function could be located in different module</span>
|
|||
|
|
<span class="kw">fn</span> <span class="ident">config</span>(<span class="ident">app</span>: <span class="ident">App</span>) <span class="op">-></span> <span class="ident">App</span> {
|
|||
|
|
<span class="ident">app</span>.<span class="ident">resource</span>(<span class="string">"/test"</span>, <span class="op">|</span><span class="ident">r</span><span class="op">|</span> {
|
|||
|
|
<span class="ident">r</span>.<span class="ident">get</span>().<span class="ident">f</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>());
|
|||
|
|
<span class="ident">r</span>.<span class="ident">head</span>().<span class="ident">f</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="ident">HttpResponse</span>::<span class="ident">MethodNotAllowed</span>());
|
|||
|
|
})
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
<span class="kw">fn</span> <span class="ident">main</span>() {
|
|||
|
|
<span class="kw">let</span> <span class="ident">app</span> <span class="op">=</span> <span class="ident">App</span>::<span class="ident">new</span>()
|
|||
|
|
.<span class="ident">middleware</span>(<span class="ident">middleware</span>::<span class="ident">Logger</span>::<span class="ident">default</span>())
|
|||
|
|
.<span class="ident">configure</span>(<span class="ident">config</span>) <span class="comment">// <- register resources</span>
|
|||
|
|
.<span class="ident">handler</span>(<span class="string">"/static"</span>, <span class="ident">fs</span>::<span class="ident">StaticFiles</span>::<span class="ident">new</span>(<span class="string">"."</span>).<span class="ident">unwrap</span>());
|
|||
|
|
}</pre>
|
|||
|
|
</div><h4 id='method.finish' class="method"><span id='finish.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.finish' class='fnname'>finish</a>(&mut self) -> HttpApplication<S></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/actix_web/application.rs.html#505-528' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Finish application configuration and create <code>HttpHandler</code> object.</p>
|
|||
|
|
</div><h4 id='method.boxed' class="method"><span id='boxed.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.boxed' class='fnname'>boxed</a>(self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><<a class="trait" href="../actix_web/server/trait.HttpHandler.html" title="trait actix_web::server::HttpHandler">HttpHandler</a><Task = <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><<a class="trait" href="../actix_web/server/trait.HttpHandlerTask.html" title="trait actix_web::server::HttpHandlerTask">HttpHandlerTask</a>>>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/actix_web/application.rs.html#563-565' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Convenience method for creating <code>Box<HttpHandler></code> instances.</p>
|
|||
|
|
<p>This method is useful if you need to register multiple
|
|||
|
|
application instances with different state.</p>
|
|||
|
|
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">server</span>, <span class="ident">App</span>, <span class="ident">HttpResponse</span>};
|
|||
|
|
|
|||
|
|
<span class="kw">struct</span> <span class="ident">State1</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">struct</span> <span class="ident">State2</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">fn</span> <span class="ident">main</span>() {
|
|||
|
|
<span class="ident">server</span>::<span class="ident">new</span>(<span class="op">||</span> {
|
|||
|
|
<span class="macro">vec</span><span class="macro">!</span>[
|
|||
|
|
<span class="ident">App</span>::<span class="ident">with_state</span>(<span class="ident">State1</span>)
|
|||
|
|
.<span class="ident">prefix</span>(<span class="string">"/app1"</span>)
|
|||
|
|
.<span class="ident">resource</span>(<span class="string">"/"</span>, <span class="op">|</span><span class="ident">r</span><span class="op">|</span> <span class="ident">r</span>.<span class="ident">f</span>(<span class="op">|</span><span class="ident">r</span><span class="op">|</span> <span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>()))
|
|||
|
|
.<span class="ident">boxed</span>(),
|
|||
|
|
<span class="ident">App</span>::<span class="ident">with_state</span>(<span class="ident">State2</span>)
|
|||
|
|
.<span class="ident">prefix</span>(<span class="string">"/app2"</span>)
|
|||
|
|
.<span class="ident">resource</span>(<span class="string">"/"</span>, <span class="op">|</span><span class="ident">r</span><span class="op">|</span> <span class="ident">r</span>.<span class="ident">f</span>(<span class="op">|</span><span class="ident">r</span><span class="op">|</span> <span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>()))
|
|||
|
|
.<span class="ident">boxed</span>(),
|
|||
|
|
]
|
|||
|
|
}).<span class="ident">bind</span>(<span class="string">"127.0.0.1:8080"</span>)
|
|||
|
|
.<span class="ident">unwrap</span>()
|
|||
|
|
.<span class="ident">run</span>()
|
|||
|
|
}</pre>
|
|||
|
|
</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-IntoHttpHandler' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<S: 'static> <a class="trait" href="../actix_web/server/trait.IntoHttpHandler.html" title="trait actix_web::server::IntoHttpHandler">IntoHttpHandler</a> for <a class="struct" href="../actix_web/struct.App.html" title="struct actix_web::App">App</a><S></code><a href='#impl-IntoHttpHandler' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/actix_web/application.rs.html#583-589' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Handler' class="type"><span id='Handler.t' class='invisible'><code>type <a href='../actix_web/server/trait.IntoHttpHandler.html#associatedtype.Handler' class="type">Handler</a> = HttpApplication<S></code></span></h4>
|
|||
|
|
<div class='docblock'><p>The associated type which is result of conversion.</p>
|
|||
|
|
</div><h4 id='method.into_handler' class="method"><span id='into_handler.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../actix_web/server/trait.IntoHttpHandler.html#tymethod.into_handler' class='fnname'>into_handler</a>(self) -> HttpApplication<S></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/actix_web/application.rs.html#586-588' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Convert into <code>HttpHandler</code> object.</p>
|
|||
|
|
</div></div><h3 id='impl-IntoHttpHandler-1' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'a, S: 'static> <a class="trait" href="../actix_web/server/trait.IntoHttpHandler.html" title="trait actix_web::server::IntoHttpHandler">IntoHttpHandler</a> for &'a mut <a class="struct" href="../actix_web/struct.App.html" title="struct actix_web::App">App</a><S></code><a href='#impl-IntoHttpHandler-1' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/actix_web/application.rs.html#591-597' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Handler-1' class="type"><span id='Handler.t-1' class='invisible'><code>type <a href='../actix_web/server/trait.IntoHttpHandler.html#associatedtype.Handler' class="type">Handler</a> = HttpApplication<S></code></span></h4>
|
|||
|
|
<div class='docblock'><p>The associated type which is result of conversion.</p>
|
|||
|
|
</div><h4 id='method.into_handler-1' class="method"><span id='into_handler.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../actix_web/server/trait.IntoHttpHandler.html#tymethod.into_handler' class='fnname'>into_handler</a>(self) -> HttpApplication<S></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/actix_web/application.rs.html#594-596' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Convert into <code>HttpHandler</code> object.</p>
|
|||
|
|
</div></div><h3 id='impl-Default' 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/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="../actix_web/struct.App.html" title="struct actix_web::App">App</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></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/actix_web/application.rs.html#117-121' 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>() -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/actix_web/application.rs.html#118-120' 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></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<S = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>> !<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.App.html" title="struct actix_web::App">App</a><S></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<S = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</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="../actix_web/struct.App.html" title="struct actix_web::App">App</a><S></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-IntoIterator' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<I> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a> for I <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>, </span></code><a href='#impl-IntoIterator' 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/iter/traits.rs.html#255-262' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Item' class="type"><span id='Item.t' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#associatedtype.Item' class="type">Item</a> = <I as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item" title="type core::iter::iterator::Iterator::Item">Item</a></code></span></h4>
|
|||
|
|
<div class='docblock'><p>The type of the elements being iterated over.</p>
|
|||
|
|
</div><h4 id='associatedtype.IntoIter' class="type"><span id='IntoIter.t' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#associatedtype.IntoIter' class="type">IntoIter</a> = I</code></span></h4>
|
|||
|
|
<div class='docblock'><p>Which kind of iterator are we turning this into?</p>
|
|||
|
|
</div><h4 id='method.into_iter' class="method"><span id='into_iter.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#tymethod.into_iter' class='fnname'>into_iter</a>(self) -> I</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/iter/traits.rs.html#259-261' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates an iterator from a value. <a href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#tymethod.into_iter">Read more</a></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>
|