mirror of
https://github.com/actix/actix-website
synced 2024-11-28 10:32:38 +01:00
160 lines
42 KiB
HTML
160 lines
42 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 `Scope` struct in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, Scope"><title>actix_web::Scope - 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 Scope</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.filter">filter</a><a href="#method.with_state">with_state</a><a href="#method.nested">nested</a><a href="#method.route">route</a><a href="#method.resource">resource</a><a href="#method.default_resource">default_resource</a><a href="#method.handler">handler</a><a href="#method.middleware">middleware</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></p><script>window.sidebarCurrent = {name: 'Scope', 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/scope.rs.html#55-60' title='goto source code'>[src]</a></span><span class='in-band'>Struct <a href='index.html'>actix_web</a>::<wbr><a class="struct" href=''>Scope</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust struct'>pub struct Scope<S> { /* fields omitted */ }</pre></div><div class='docblock'><p>Resources scope</p>
|
|||
|
|
<p>Scope is a set of resources with common root path.
|
|||
|
|
Scopes collect multiple paths under a common path prefix.
|
|||
|
|
Scope path can contain variable path segments as resources.
|
|||
|
|
Scope prefix is always complete path segment, i.e <code>/app</code> would
|
|||
|
|
be converted to a <code>/app/</code> and it would not match <code>/app</code> path.</p>
|
|||
|
|
<p>You can get variable path segments from <code>HttpRequest::match_info()</code>.
|
|||
|
|
<code>Path</code> extractor also is able to extract scope level variable segments.</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 registered:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li>/{project_id}/path1 - reponds to all http method</li>
|
|||
|
|
<li>/{project_id}/path2 - <code>GET</code> requests</li>
|
|||
|
|
<li>/{project_id}/path3 - <code>HEAD</code> requests</li>
|
|||
|
|
</ul>
|
|||
|
|
</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<S: 'static> <a class="struct" href="../actix_web/struct.Scope.html" title="struct actix_web::Scope">Scope</a><S></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/scope.rs.html#66-339' 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>(path: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="struct" href="../actix_web/struct.Scope.html" title="struct actix_web::Scope">Scope</a><S></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/actix_web/scope.rs.html#68-76' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create a new scope</p>
|
|||
|
|
</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) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/actix_web/scope.rs.html#113-116' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Add match predicate to scope.</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">pred</span>, <span class="ident">App</span>, <span class="ident">HttpRequest</span>, <span class="ident">HttpResponse</span>, <span class="ident">Path</span>};
|
|||
|
|
|
|||
|
|
<span class="kw">fn</span> <span class="ident">index</span>(<span class="ident">data</span>: <span class="ident">Path</span><span class="op"><</span>(<span class="ident">String</span>, <span class="ident">String</span>)<span class="op">></span>) <span class="op">-></span> <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span> {
|
|||
|
|
<span class="string">"Welcome!"</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">"/app"</span>, <span class="op">|</span><span class="ident">scope</span><span class="op">|</span> {
|
|||
|
|
<span class="ident">scope</span>
|
|||
|
|
.<span class="ident">filter</span>(<span class="ident">pred</span>::<span class="ident">Header</span>(<span class="string">"content-type"</span>, <span class="string">"text/plain"</span>))
|
|||
|
|
.<span class="ident">route</span>(<span class="string">"/test1"</span>, <span class="ident">http</span>::<span class="ident">Method</span>::<span class="ident">GET</span>, <span class="ident">index</span>)
|
|||
|
|
.<span class="ident">route</span>(<span class="string">"/test2"</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.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><F, T: 'static>(self, path: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, state: T, f: F) -> <a class="struct" href="../actix_web/struct.Scope.html" title="struct actix_web::Scope">Scope</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><T>) -> <a class="struct" href="../actix_web/struct.Scope.html" title="struct actix_web::Scope">Scope</a><T>, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/actix_web/scope.rs.html#138-165' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create nested scope with new state.</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="kw">struct</span> <span class="ident">AppState</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="ident">AppState</span><span class="op">></span>) <span class="op">-></span> <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span> {
|
|||
|
|
<span class="string">"Welcome!"</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">"/app"</span>, <span class="op">|</span><span class="ident">scope</span><span class="op">|</span> {
|
|||
|
|
<span class="ident">scope</span>.<span class="ident">with_state</span>(<span class="string">"/state2"</span>, <span class="ident">AppState</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">"/test1"</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="ident">index</span>))
|
|||
|
|
})
|
|||
|
|
});
|
|||
|
|
}</pre>
|
|||
|
|
</div><h4 id='method.nested' class="method"><span id='nested.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.nested' class='fnname'>nested</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.Scope.html" title="struct actix_web::Scope">Scope</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/scope.rs.html#185-201' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create nested scope.</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="kw">struct</span> <span class="ident">AppState</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="ident">AppState</span><span class="op">></span>) <span class="op">-></span> <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span> {
|
|||
|
|
<span class="string">"Welcome!"</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">with_state</span>(<span class="ident">AppState</span>).<span class="ident">scope</span>(<span class="string">"/app"</span>, <span class="op">|</span><span class="ident">scope</span><span class="op">|</span> {
|
|||
|
|
<span class="ident">scope</span>.<span class="ident">nested</span>(<span class="string">"/v1"</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">"/test1"</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="ident">index</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.Scope.html" title="struct actix_web::Scope">Scope</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/scope.rs.html#230-242' 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>Scope::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="ident">Path</span>};
|
|||
|
|
|
|||
|
|
<span class="kw">fn</span> <span class="ident">index</span>(<span class="ident">data</span>: <span class="ident">Path</span><span class="op"><</span>(<span class="ident">String</span>, <span class="ident">String</span>)<span class="op">></span>) <span class="op">-></span> <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span> {
|
|||
|
|
<span class="string">"Welcome!"</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">"/app"</span>, <span class="op">|</span><span class="ident">scope</span><span class="op">|</span> {
|
|||
|
|
<span class="ident">scope</span>.<span class="ident">route</span>(<span class="string">"/test1"</span>, <span class="ident">http</span>::<span class="ident">Method</span>::<span class="ident">GET</span>, <span class="ident">index</span>).<span class="ident">route</span>(
|
|||
|
|
<span class="string">"/test2"</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.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.Scope.html" title="struct actix_web::Scope">Scope</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/scope.rs.html#267-279' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Configure resource for a specific path.</p>
|
|||
|
|
<p>This method is similar to an <code>App::resource()</code> method.
|
|||
|
|
Resources may have variable path segments. Resource path uses scope
|
|||
|
|
path as a path prefix.</p>
|
|||
|
|
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">actix_web</span>::<span class="kw-2">*</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">"/api"</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">"/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>());
|
|||
|
|
<span class="ident">r</span>.<span class="ident">route</span>()
|
|||
|
|
.<span class="ident">filter</span>(<span class="ident">pred</span>::<span class="ident">Any</span>(<span class="ident">pred</span>::<span class="ident">Get</span>()).<span class="ident">or</span>(<span class="ident">pred</span>::<span class="ident">Put</span>()))
|
|||
|
|
.<span class="ident">filter</span>(<span class="ident">pred</span>::<span class="ident">Header</span>(<span class="string">"Content-Type"</span>, <span class="string">"text/plain"</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.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.Scope.html" title="struct actix_web::Scope">Scope</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/scope.rs.html#282-295' 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.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.Scope.html" title="struct actix_web::Scope">Scope</a><S></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/actix_web/scope.rs.html#318-324' 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>
|
|||
|
|
|
|||
|
|
<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">"/scope-prefix"</span>, <span class="op">|</span><span class="ident">scope</span><span class="op">|</span> {
|
|||
|
|
<span class="ident">scope</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.Scope.html" title="struct actix_web::Scope">Scope</a><S></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/actix_web/scope.rs.html#333-338' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Register a scope middleware</p>
|
|||
|
|
<p>This is similar to <code>App's</code> middlewares, but
|
|||
|
|
middlewares get invoked on scope level.</p>
|
|||
|
|
<p><em>Note</em> <code>Middleware::finish()</code> fires right after response get
|
|||
|
|
prepared. It does not wait until body get sent to the peer.</p>
|
|||
|
|
</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="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.Scope.html" title="struct actix_web::Scope">Scope</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="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.Scope.html" title="struct actix_web::Scope">Scope</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-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>
|