192 lines
47 KiB
HTML
192 lines
47 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><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc 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><a href='../actix_web/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><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.configure">configure</a><a href="#method.data">data</a><a href="#method.default_service">default_service</a><a href="#method.guard">guard</a><a href="#method.new">new</a><a href="#method.register_data">register_data</a><a href="#method.route">route</a><a href="#method.service">service</a><a href="#method.wrap">wrap</a><a href="#method.wrap_fn">wrap_fn</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-HttpServiceFactory">HttpServiceFactory</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">!RefUnwindSafe</a><a href="#impl-Send">!Send</a><a href="#impl-Sync">!Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">!UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a><a href="#impl-VZip%3CV%3E">VZip<V></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"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../src/actix_web/scope.rs.html#63-72' 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<T = ScopeEndpoint> { /* 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>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">web</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">service</span>(
|
||
<span class="ident">web</span>::<span class="ident">scope</span>(<span class="string">"/{project_id}/"</span>)
|
||
.<span class="ident">service</span>(<span class="ident">web</span>::<span class="ident">resource</span>(<span class="string">"/path1"</span>).<span class="ident">to</span>(<span class="op">|</span><span class="op">|</span> <span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>()))
|
||
.<span class="ident">service</span>(<span class="ident">web</span>::<span class="ident">resource</span>(<span class="string">"/path2"</span>).<span class="ident">route</span>(<span class="ident">web</span>::<span class="ident">get</span>().<span class="ident">to</span>(<span class="op">|</span><span class="op">|</span> <span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>())))
|
||
.<span class="ident">service</span>(<span class="ident">web</span>::<span class="ident">resource</span>(<span class="string">"/path3"</span>).<span class="ident">route</span>(<span class="ident">web</span>::<span class="ident">head</span>().<span class="ident">to</span>(<span class="op">|</span><span class="op">|</span> <span class="ident">HttpResponse</span>::<span class="ident">MethodNotAllowed</span>())))
|
||
);
|
||
}</pre></div>
|
||
<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'><code class='in-band'>impl <a class="struct" href="../actix_web/struct.Scope.html" title="struct actix_web::Scope">Scope</a></code><a href='#impl' class='anchor'></a><a class='srclink' href='../src/actix_web/scope.rs.html#74-89' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.new' class="method"><code id='new.v'>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></code><a class='srclink' href='../src/actix_web/scope.rs.html#76-88' title='goto source code'>[src]</a></h4><div class='docblock'><p>Create a new scope</p>
|
||
</div></div><h3 id='impl-1' class='impl'><code class='in-band'>impl<T> <a class="struct" href="../actix_web/struct.Scope.html" title="struct actix_web::Scope">Scope</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="../actix_service/trait.NewService.html" title="trait actix_service::NewService">NewService</a><Config = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Request = <a class="struct" href="../actix_web/dev/struct.ServiceRequest.html" title="struct actix_web::dev::ServiceRequest">ServiceRequest</a>, Response = <a class="struct" href="../actix_web/dev/struct.ServiceResponse.html" title="struct actix_web::dev::ServiceResponse">ServiceResponse</a>, Error = <a class="struct" href="../actix_web/error/struct.Error.html" title="struct actix_web::error::Error">Error</a>, InitError = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>, </span></code><a href='#impl-1' class='anchor'></a><a class='srclink' href='../src/actix_web/scope.rs.html#91-399' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.guard' class="method"><code id='guard.v'>pub fn <a href='#method.guard' class='fnname'>guard</a><G: <a class="trait" href="../actix_web/guard/trait.Guard.html" title="trait actix_web::guard::Guard">Guard</a> + 'static>(self, guard: G) -> Self</code><a class='srclink' href='../src/actix_web/scope.rs.html#121-124' title='goto source code'>[src]</a></h4><div class='docblock'><p>Add match guard to a scope.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">web</span>, <span class="ident">guard</span>, <span class="ident">App</span>, <span class="ident">HttpRequest</span>, <span class="ident">HttpResponse</span>};
|
||
|
||
<span class="kw">fn</span> <span class="ident">index</span>(<span class="ident">data</span>: <span class="ident">web</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="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">service</span>(
|
||
<span class="ident">web</span>::<span class="ident">scope</span>(<span class="string">"/app"</span>)
|
||
.<span class="ident">guard</span>(<span class="ident">guard</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">web</span>::<span class="ident">get</span>().<span class="ident">to</span>(<span class="ident">index</span>))
|
||
.<span class="ident">route</span>(<span class="string">"/test2"</span>, <span class="ident">web</span>::<span class="ident">post</span>().<span class="ident">to</span>(<span class="op">|</span><span class="ident">r</span>: <span class="ident">HttpRequest</span><span class="op">|</span> {
|
||
<span class="ident">HttpResponse</span>::<span class="ident">MethodNotAllowed</span>()
|
||
}))
|
||
);
|
||
}</pre></div>
|
||
</div><h4 id='method.data' class="method"><code id='data.v'>pub fn <a href='#method.data' class='fnname'>data</a><U: 'static>(self, data: U) -> Self</code><a class='srclink' href='../src/actix_web/scope.rs.html#151-153' title='goto source code'>[src]</a></h4><div class='docblock'><p>Set or override application data. Application data could be accessed
|
||
by using <code>Data<T></code> extractor where <code>T</code> is data type.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">cell</span>::<span class="ident">Cell</span>;
|
||
<span class="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">web</span>, <span class="ident">App</span>};
|
||
|
||
<span class="kw">struct</span> <span class="ident">MyData</span> {
|
||
<span class="ident">counter</span>: <span class="ident">Cell</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span>,
|
||
}
|
||
|
||
<span class="kw">fn</span> <span class="ident">index</span>(<span class="ident">data</span>: <span class="ident">web</span>::<span class="ident">Data</span><span class="op"><</span><span class="ident">MyData</span><span class="op">></span>) {
|
||
<span class="ident">data</span>.<span class="ident">counter</span>.<span class="ident">set</span>(<span class="ident">data</span>.<span class="ident">counter</span>.<span class="ident">get</span>() <span class="op">+</span> <span class="number">1</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">service</span>(
|
||
<span class="ident">web</span>::<span class="ident">scope</span>(<span class="string">"/app"</span>)
|
||
.<span class="ident">data</span>(<span class="ident">MyData</span>{ <span class="ident">counter</span>: <span class="ident">Cell</span>::<span class="ident">new</span>(<span class="number">0</span>) })
|
||
.<span class="ident">service</span>(
|
||
<span class="ident">web</span>::<span class="ident">resource</span>(<span class="string">"/index.html"</span>).<span class="ident">route</span>(
|
||
<span class="ident">web</span>::<span class="ident">get</span>().<span class="ident">to</span>(<span class="ident">index</span>)))
|
||
);
|
||
}</pre></div>
|
||
</div><h4 id='method.register_data' class="method"><code id='register_data.v'>pub fn <a href='#method.register_data' class='fnname'>register_data</a><U: 'static>(self, data: <a class="struct" href="../actix_web/web/struct.Data.html" title="struct actix_web::web::Data">Data</a><U>) -> Self</code><a class='srclink' href='../src/actix_web/scope.rs.html#160-166' title='goto source code'>[src]</a></h4><div class='docblock'><p>Set or override application data.</p>
|
||
<p>This method has the same effect as <a href="#method.data"><code>Scope::data</code></a>, except
|
||
that instead of taking a value of some type <code>T</code>, it expects a value of
|
||
type <code>Data<T></code>. Use a <code>Data<T></code> extractor to retrieve its value.</p>
|
||
</div><h4 id='method.configure' class="method"><code id='configure.v'>pub fn <a href='#method.configure' class='fnname'>configure</a><F>(self, f: F) -> Self <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/web/struct.ServiceConfig.html" title="struct actix_web::web::ServiceConfig">ServiceConfig</a>), </span></code><a class='srclink' href='../src/actix_web/scope.rs.html#197-216' title='goto source code'>[src]</a></h4><div class='docblock'><p>Run external configuration as part of the scope building
|
||
process</p>
|
||
<p>This function is useful for moving parts of configuration to a
|
||
different module or even library. For example,
|
||
some of the resource's configuration could be moved to different module.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">web</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">cfg</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">web</span>::<span class="ident">ServiceConfig</span>) {
|
||
<span class="ident">cfg</span>.<span class="ident">service</span>(<span class="ident">web</span>::<span class="ident">resource</span>(<span class="string">"/test"</span>)
|
||
.<span class="ident">route</span>(<span class="ident">web</span>::<span class="ident">get</span>().<span class="ident">to</span>(<span class="op">|</span><span class="op">|</span> <span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>()))
|
||
.<span class="ident">route</span>(<span class="ident">web</span>::<span class="ident">head</span>().<span class="ident">to</span>(<span class="op">|</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">wrap</span>(<span class="ident">middleware</span>::<span class="ident">Logger</span>::<span class="ident">default</span>())
|
||
.<span class="ident">service</span>(
|
||
<span class="ident">web</span>::<span class="ident">scope</span>(<span class="string">"/api"</span>)
|
||
.<span class="ident">configure</span>(<span class="ident">config</span>)
|
||
)
|
||
.<span class="ident">route</span>(<span class="string">"/index.html"</span>, <span class="ident">web</span>::<span class="ident">get</span>().<span class="ident">to</span>(<span class="op">|</span><span class="op">|</span> <span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>()));
|
||
}</pre></div>
|
||
</div><h4 id='method.service' class="method"><code id='service.v'>pub fn <a href='#method.service' class='fnname'>service</a><F>(self, factory: F) -> Self <span class="where fmt-newline">where<br> F: <a class="trait" href="../actix_web/dev/trait.HttpServiceFactory.html" title="trait actix_web::dev::HttpServiceFactory">HttpServiceFactory</a> + 'static, </span></code><a class='srclink' href='../src/actix_web/scope.rs.html#245-252' title='goto source code'>[src]</a></h4><div class='docblock'><p>Register http service.</p>
|
||
<p>This is similar to <code>App's</code> service registration.</p>
|
||
<p>Actix web provides several services implementations:</p>
|
||
<ul>
|
||
<li><em>Resource</em> is an entry in resource table which corresponds to requested URL.</li>
|
||
<li><em>Scope</em> is a set of resources with common root path.</li>
|
||
<li>"StaticFiles" is a service for static files support</li>
|
||
</ul>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">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="ident">HttpRequest</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">service</span>(
|
||
<span class="ident">web</span>::<span class="ident">scope</span>(<span class="string">"/app"</span>).<span class="ident">service</span>(
|
||
<span class="ident">web</span>::<span class="ident">scope</span>(<span class="string">"/v1"</span>)
|
||
.<span class="ident">service</span>(<span class="ident">web</span>::<span class="ident">resource</span>(<span class="string">"/test1"</span>).<span class="ident">to</span>(<span class="ident">index</span>)))
|
||
);
|
||
}</pre></div>
|
||
</div><h4 id='method.route' class="method"><code id='route.v'>pub fn <a href='#method.route' class='fnname'>route</a>(self, path: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, route: <a class="struct" href="../actix_web/struct.Route.html" title="struct actix_web::Route">Route</a>) -> Self</code><a class='srclink' href='../src/actix_web/scope.rs.html#275-281' title='goto source code'>[src]</a></h4><div class='docblock'><p>Configure route for a specific path.</p>
|
||
<p>This is a simplified version of the <code>Scope::service()</code> method.
|
||
This method can be called multiple times, in that case
|
||
multiple resources with one route would be registered for same resource path.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">web</span>, <span class="ident">App</span>, <span class="ident">HttpResponse</span>};
|
||
|
||
<span class="kw">fn</span> <span class="ident">index</span>(<span class="ident">data</span>: <span class="ident">web</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="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">service</span>(
|
||
<span class="ident">web</span>::<span class="ident">scope</span>(<span class="string">"/app"</span>)
|
||
.<span class="ident">route</span>(<span class="string">"/test1"</span>, <span class="ident">web</span>::<span class="ident">get</span>().<span class="ident">to</span>(<span class="ident">index</span>))
|
||
.<span class="ident">route</span>(<span class="string">"/test2"</span>, <span class="ident">web</span>::<span class="ident">post</span>().<span class="ident">to</span>(<span class="op">|</span><span class="op">|</span> <span class="ident">HttpResponse</span>::<span class="ident">MethodNotAllowed</span>()))
|
||
);
|
||
}</pre></div>
|
||
</div><h4 id='method.default_service' class="method"><code id='default_service.v'>pub fn <a href='#method.default_service' class='fnname'>default_service</a><F, U>(self, f: F) -> Self <span class="where fmt-newline">where<br> F: <a class="trait" href="../actix_service/trait.IntoNewService.html" title="trait actix_service::IntoNewService">IntoNewService</a><U>,<br> U: <a class="trait" href="../actix_service/trait.NewService.html" title="trait actix_service::NewService">NewService</a><Config = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Request = <a class="struct" href="../actix_web/dev/struct.ServiceRequest.html" title="struct actix_web::dev::ServiceRequest">ServiceRequest</a>, Response = <a class="struct" href="../actix_web/dev/struct.ServiceResponse.html" title="struct actix_web::dev::ServiceResponse">ServiceResponse</a>, Error = <a class="struct" href="../actix_web/error/struct.Error.html" title="struct actix_web::error::Error">Error</a>> + 'static,<br> U::<a class="type" href="../actix_service/trait.NewService.html#associatedtype.InitError" title="type actix_service::NewService::InitError">InitError</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>, </span></code><a class='srclink' href='../src/actix_web/scope.rs.html#286-305' title='goto source code'>[src]</a></h4><div class='docblock'><p>Default service to be used if no matching route could be found.</p>
|
||
<p>If default resource is not registered, app's default resource is being used.</p>
|
||
</div><h4 id='method.wrap' class="method"><code id='wrap.v'>pub fn <a href='#method.wrap' class='fnname'>wrap</a><M, F>(<br> self, <br> mw: F<br>) -> <a class="struct" href="../actix_web/struct.Scope.html" title="struct actix_web::Scope">Scope</a><impl <a class="trait" href="../actix_service/trait.NewService.html" title="trait actix_service::NewService">NewService</a><Config = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Request = <a class="struct" href="../actix_web/dev/struct.ServiceRequest.html" title="struct actix_web::dev::ServiceRequest">ServiceRequest</a>, Response = <a class="struct" href="../actix_web/dev/struct.ServiceResponse.html" title="struct actix_web::dev::ServiceResponse">ServiceResponse</a>, Error = <a class="struct" href="../actix_web/error/struct.Error.html" title="struct actix_web::error::Error">Error</a>, InitError = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>> <span class="where fmt-newline">where<br> M: <a class="trait" href="../actix_web/dev/trait.Transform.html" title="trait actix_web::dev::Transform">Transform</a><T::<a class="type" href="../actix_service/trait.NewService.html#associatedtype.Service" title="type actix_service::NewService::Service">Service</a>, Request = <a class="struct" href="../actix_web/dev/struct.ServiceRequest.html" title="struct actix_web::dev::ServiceRequest">ServiceRequest</a>, Response = <a class="struct" href="../actix_web/dev/struct.ServiceResponse.html" title="struct actix_web::dev::ServiceResponse">ServiceResponse</a>, Error = <a class="struct" href="../actix_web/error/struct.Error.html" title="struct actix_web::error::Error">Error</a>, InitError = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>,<br> F: <a class="trait" href="../actix_service/transform/trait.IntoTransform.html" title="trait actix_service::transform::IntoTransform">IntoTransform</a><M, T::<a class="type" href="../actix_service/trait.NewService.html#associatedtype.Service" title="type actix_service::NewService::Service">Service</a>>, </span></code><a class='srclink' href='../src/actix_web/scope.rs.html#316-349' title='goto source code'>[src]</a></h4><div class='docblock'><p>Registers middleware, in the form of a middleware component (type),
|
||
that runs during inbound processing in the request
|
||
lifecycle (request -> response), modifying request as
|
||
necessary, across all requests managed by the <em>Scope</em>. Scope-level
|
||
middleware is more limited in what it can modify, relative to Route or
|
||
Application level middleware, in that Scope-level middleware can not modify
|
||
ServiceResponse.</p>
|
||
<p>Use middleware when you need to read or modify <em>every</em> request in some way.</p>
|
||
</div><h4 id='method.wrap_fn' class="method"><code id='wrap_fn.v'>pub fn <a href='#method.wrap_fn' class='fnname'>wrap_fn</a><F, R>(<br> self, <br> mw: F<br>) -> <a class="struct" href="../actix_web/struct.Scope.html" title="struct actix_web::Scope">Scope</a><impl <a class="trait" href="../actix_service/trait.NewService.html" title="trait actix_service::NewService">NewService</a><Config = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Request = <a class="struct" href="../actix_web/dev/struct.ServiceRequest.html" title="struct actix_web::dev::ServiceRequest">ServiceRequest</a>, Response = <a class="struct" href="../actix_web/dev/struct.ServiceResponse.html" title="struct actix_web::dev::ServiceResponse">ServiceResponse</a>, Error = <a class="struct" href="../actix_web/error/struct.Error.html" title="struct actix_web::error::Error">Error</a>, InitError = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="struct" href="../actix_web/dev/struct.ServiceRequest.html" title="struct actix_web::dev::ServiceRequest">ServiceRequest</a>, &mut T::<a class="type" href="../actix_service/trait.NewService.html#associatedtype.Service" title="type actix_service::NewService::Service">Service</a>) -> R + <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,<br> R: <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Item = <a class="struct" href="../actix_web/dev/struct.ServiceResponse.html" title="struct actix_web::dev::ServiceResponse">ServiceResponse</a>, Error = <a class="struct" href="../actix_web/error/struct.Error.html" title="struct actix_web::error::Error">Error</a>>, </span></code><a class='srclink' href='../src/actix_web/scope.rs.html#381-398' title='goto source code'>[src]</a></h4><div class='docblock'><p>Registers middleware, in the form of a closure, that runs during inbound
|
||
processing in the request lifecycle (request -> response), modifying
|
||
request as necessary, across all requests managed by the <em>Scope</em>.
|
||
Scope-level middleware is more limited in what it can modify, relative
|
||
to Route or Application level middleware, in that Scope-level middleware
|
||
can not modify ServiceResponse.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">actix_service</span>::<span class="ident">Service</span>;
|
||
<span class="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">web</span>, <span class="ident">App</span>};
|
||
<span class="kw">use</span> <span class="ident">actix_web</span>::<span class="ident">http</span>::{<span class="ident">header</span>::<span class="ident">CONTENT_TYPE</span>, <span class="ident">HeaderValue</span>};
|
||
|
||
<span class="kw">fn</span> <span class="ident">index</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">service</span>(
|
||
<span class="ident">web</span>::<span class="ident">scope</span>(<span class="string">"/app"</span>)
|
||
.<span class="ident">wrap_fn</span>(<span class="op">|</span><span class="ident">req</span>, <span class="ident">srv</span><span class="op">|</span>
|
||
<span class="ident">srv</span>.<span class="ident">call</span>(<span class="ident">req</span>).<span class="ident">map</span>(<span class="op">|</span><span class="kw-2">mut</span> <span class="ident">res</span><span class="op">|</span> {
|
||
<span class="ident">res</span>.<span class="ident">headers_mut</span>().<span class="ident">insert</span>(
|
||
<span class="ident">CONTENT_TYPE</span>, <span class="ident">HeaderValue</span>::<span class="ident">from_static</span>(<span class="string">"text/plain"</span>),
|
||
);
|
||
<span class="ident">res</span>
|
||
}))
|
||
.<span class="ident">route</span>(<span class="string">"/index.html"</span>, <span class="ident">web</span>::<span class="ident">get</span>().<span class="ident">to</span>(<span class="ident">index</span>)));
|
||
}</pre></div>
|
||
</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-HttpServiceFactory' class='impl'><code class='in-band'>impl<T> <a class="trait" href="../actix_web/dev/trait.HttpServiceFactory.html" title="trait actix_web::dev::HttpServiceFactory">HttpServiceFactory</a> for <a class="struct" href="../actix_web/struct.Scope.html" title="struct actix_web::Scope">Scope</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="../actix_service/trait.NewService.html" title="trait actix_service::NewService">NewService</a><Config = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Request = <a class="struct" href="../actix_web/dev/struct.ServiceRequest.html" title="struct actix_web::dev::ServiceRequest">ServiceRequest</a>, Response = <a class="struct" href="../actix_web/dev/struct.ServiceResponse.html" title="struct actix_web::dev::ServiceResponse">ServiceResponse</a>, Error = <a class="struct" href="../actix_web/error/struct.Error.html" title="struct actix_web::error::Error">Error</a>, InitError = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>> + 'static, </span></code><a href='#impl-HttpServiceFactory' class='anchor'></a><a class='srclink' href='../src/actix_web/scope.rs.html#401-466' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.register' class="method hidden"><code id='register.v'>fn <a href='../actix_web/dev/trait.HttpServiceFactory.html#tymethod.register' class='fnname'>register</a>(self, config: &mut <a class="struct" href="../actix_web/dev/struct.AppService.html" title="struct actix_web::dev::AppService">AppService</a>)</code><a class='srclink' href='../src/actix_web/scope.rs.html#411-465' title='goto source code'>[src]</a></h4></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-RefUnwindSafe' class='impl'><code class='in-band'>impl<T = ScopeEndpoint> !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../actix_web/struct.Scope.html" title="struct actix_web::Scope">Scope</a><T></code><a href='#impl-RefUnwindSafe' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Send' class='impl'><code class='in-band'>impl<T = ScopeEndpoint> !<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><T></code><a href='#impl-Send' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><code class='in-band'>impl<T = ScopeEndpoint> !<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><T></code><a href='#impl-Sync' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Unpin' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../actix_web/struct.Scope.html" title="struct actix_web::Scope">Scope</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>, </span></code><a href='#impl-Unpin' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-UnwindSafe' class='impl'><code class='in-band'>impl<T = ScopeEndpoint> !<a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../actix_web/struct.Scope.html" title="struct actix_web::Scope">Scope</a><T></code><a href='#impl-UnwindSafe' class='anchor'></a></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-Any' class='impl'><code class='in-band'>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><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#108-112' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.type_id' class="method hidden"><code id='type_id.v'>fn <a href='https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id' class='fnname'>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><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#109-111' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||
</div></div><h3 id='impl-Borrow%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> 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%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213-217' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow' class="method hidden"><code id='borrow.v'>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><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214-216' title='goto source code'>[src]</a></h4><div class='docblock hidden'><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%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> 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%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#220-224' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow_mut' class="method hidden"><code id='borrow_mut.v'>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><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#221-223' title='goto source code'>[src]</a></h4><div class='docblock hidden'><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-From%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href='#impl-From%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#564-568' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from' class="method hidden"><code id='from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(t: T) -> T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#565-567' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id='impl-Into%3CU%3E' class='impl'><code class='in-band'>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><U> 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%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#553-560' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.into' class="method hidden"><code id='into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into' class='fnname'>into</a>(self) -> U</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#557-559' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id='impl-TryFrom%3CU%3E' class='impl'><code class='in-band'>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><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href='#impl-TryFrom%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#601-610' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error' class="type"><code id='Error.t'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error' class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div><h4 id='method.try_from' class="method hidden"><code id='try_from.v'>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><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#607-609' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id='impl-TryInto%3CU%3E' class='impl'><code class='in-band'>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><U> 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%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#587-596' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error-1' class="type"><code id='Error.t-1'>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></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div><h4 id='method.try_into' class="method hidden"><code id='try_into.v'>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><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#593-595' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id='impl-VZip%3CV%3E' class='impl'><code class='in-band'>impl<V, T> <a class="trait" href="../ppv_lite86/types/types/trait.VZip.html" title="trait ppv_lite86::types::types::VZip">VZip</a><V> for T <span class="where fmt-newline">where<br> V: <a class="trait" href="../ppv_lite86/types/types/trait.MultiLane.html" title="trait ppv_lite86::types::types::MultiLane">MultiLane</a><T>, </span></code><a href='#impl-VZip%3CV%3E' class='anchor'></a><a class='srclink' href='../src/ppv_lite86/types.rs.html#212-220' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.vzip' class="method hidden"><code id='vzip.v'>fn <a href='../ppv_lite86/types/types/trait.VZip.html#tymethod.vzip' class='fnname'>vzip</a>(self) -> V</code><a class='srclink' href='../src/ppv_lite86/types.rs.html#217-219' title='goto source code'>[src]</a></h4></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><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> |