mirror of
https://github.com/actix/actix-website
synced 2024-12-18 18:03:12 +01:00
30 lines
12 KiB
HTML
30 lines
12 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 `Middleware` trait in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, Middleware"><title>actix_web::middleware::Middleware - 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 trait"><!--[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'>Trait Middleware</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.start">start</a><a href="#method.response">response</a><a href="#method.finish">finish</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>middleware</a></p><script>window.sidebarCurrent = {name: 'Middleware', ty: 'trait', 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='in-band'>Trait <a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>middleware</a>::<wbr><a class="trait" href=''>Middleware</a></span><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/middleware/mod.rs.html#51-68' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust trait'>pub trait Middleware<S>: 'static {
|
||
fn <a href='#method.start' class='fnname'>start</a>(&self, req: &<a class="struct" href="../../actix_web/struct.HttpRequest.html" title="struct actix_web::HttpRequest">HttpRequest</a><S>) -> <a class="type" href="../../actix_web/error/type.Result.html" title="type actix_web::error::Result">Result</a><<a class="enum" href="../../actix_web/middleware/enum.Started.html" title="enum actix_web::middleware::Started">Started</a>> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.response' class='fnname'>response</a>(<br> &self, <br> req: &<a class="struct" href="../../actix_web/struct.HttpRequest.html" title="struct actix_web::HttpRequest">HttpRequest</a><S>, <br> resp: <a class="struct" href="../../actix_web/struct.HttpResponse.html" title="struct actix_web::HttpResponse">HttpResponse</a><br> ) -> <a class="type" href="../../actix_web/error/type.Result.html" title="type actix_web::error::Result">Result</a><<a class="enum" href="../../actix_web/middleware/enum.Response.html" title="enum actix_web::middleware::Response">Response</a>> { ... }
|
||
<div class='item-spacer'></div> fn <a href='#method.finish' class='fnname'>finish</a>(&self, req: &<a class="struct" href="../../actix_web/struct.HttpRequest.html" title="struct actix_web::HttpRequest">HttpRequest</a><S>, resp: &<a class="struct" href="../../actix_web/struct.HttpResponse.html" title="struct actix_web::HttpResponse">HttpResponse</a>) -> <a class="enum" href="../../actix_web/middleware/enum.Finished.html" title="enum actix_web::middleware::Finished">Finished</a> { ... }
|
||
}</pre></div><div class='docblock'><p>Middleware definition</p>
|
||
</div>
|
||
<h2 id='provided-methods' class='small-section-header'>
|
||
Provided Methods<a href='#provided-methods' class='anchor'></a>
|
||
</h2>
|
||
<div class='methods'>
|
||
<h3 id='method.start' class='method'><span id='start.v' class='invisible'><code>fn <a href='#method.start' class='fnname'>start</a>(&self, req: &<a class="struct" href="../../actix_web/struct.HttpRequest.html" title="struct actix_web::HttpRequest">HttpRequest</a><S>) -> <a class="type" href="../../actix_web/error/type.Result.html" title="type actix_web::error::Result">Result</a><<a class="enum" href="../../actix_web/middleware/enum.Started.html" title="enum actix_web::middleware::Started">Started</a>></code></span></h3><div class='docblock'><p>Method is called when request is ready. It may return
|
||
future, which should resolve before next middleware get called.</p>
|
||
</div><h3 id='method.response' class='method'><span id='response.v' class='invisible'><code>fn <a href='#method.response' class='fnname'>response</a>(&self, req: &<a class="struct" href="../../actix_web/struct.HttpRequest.html" title="struct actix_web::HttpRequest">HttpRequest</a><S>, resp: <a class="struct" href="../../actix_web/struct.HttpResponse.html" title="struct actix_web::HttpResponse">HttpResponse</a>) -> <a class="type" href="../../actix_web/error/type.Result.html" title="type actix_web::error::Result">Result</a><<a class="enum" href="../../actix_web/middleware/enum.Response.html" title="enum actix_web::middleware::Response">Response</a>></code></span></h3><div class='docblock'><p>Method is called when handler returns response,
|
||
but before sending http message to peer.</p>
|
||
</div><h3 id='method.finish' class='method'><span id='finish.v' class='invisible'><code>fn <a href='#method.finish' class='fnname'>finish</a>(&self, req: &<a class="struct" href="../../actix_web/struct.HttpRequest.html" title="struct actix_web::HttpRequest">HttpRequest</a><S>, resp: &<a class="struct" href="../../actix_web/struct.HttpResponse.html" title="struct actix_web::HttpResponse">HttpResponse</a>) -> <a class="enum" href="../../actix_web/middleware/enum.Finished.html" title="enum actix_web::middleware::Finished">Finished</a></code></span></h3><div class='docblock'><p>Method is called after body stream get sent to peer.</p>
|
||
</div></div>
|
||
<h2 id='implementors' class='small-section-header'>
|
||
Implementors<a href='#implementors' class='anchor'></a>
|
||
</h2>
|
||
<ul class='item-list' id='implementors-list'>
|
||
<li><table class='table-display'><tbody><tr><td><code>impl<S> Middleware<S> for <a class="struct" href="../../actix_web/middleware/struct.Logger.html" title="struct actix_web::middleware::Logger">Logger</a></code><td><div class='out-of-band'><a class='srclink' href='../../src/actix_web/middleware/logger.rs.html#123-135' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
||
<li><table class='table-display'><tbody><tr><td><code>impl<S> Middleware<S> for <a class="struct" href="../../actix_web/middleware/cors/struct.Cors.html" title="struct actix_web::middleware::cors::Cors">Cors</a></code><td><div class='out-of-band'><a class='srclink' href='../../src/actix_web/middleware/cors.rs.html#358-484' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
||
<li><table class='table-display'><tbody><tr><td><code>impl<S> Middleware<S> for <a class="struct" href="../../actix_web/middleware/csrf/struct.CsrfFilter.html" title="struct actix_web::middleware::csrf::CsrfFilter">CsrfFilter</a></code><td><div class='out-of-band'><a class='srclink' href='../../src/actix_web/middleware/csrf.rs.html#211-216' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
||
<li><table class='table-display'><tbody><tr><td><code>impl<S> Middleware<S> for <a class="struct" href="../../actix_web/middleware/struct.DefaultHeaders.html" title="struct actix_web::middleware::DefaultHeaders">DefaultHeaders</a></code><td><div class='out-of-band'><a class='srclink' href='../../src/actix_web/middleware/defaultheaders.rs.html#76-92' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
||
<li><table class='table-display'><tbody><tr><td><code>impl<S: 'static> Middleware<S> for <a class="struct" href="../../actix_web/middleware/struct.ErrorHandlers.html" title="struct actix_web::middleware::ErrorHandlers">ErrorHandlers</a><S></code><td><div class='out-of-band'><a class='srclink' href='../../src/actix_web/middleware/errhandlers.rs.html#72-80' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
||
<li><table class='table-display'><tbody><tr><td><code>impl<S: 'static, T: <a class="trait" href="../../actix_web/middleware/identity/trait.IdentityPolicy.html" title="trait actix_web::middleware::identity::IdentityPolicy">IdentityPolicy</a><S>> Middleware<S> for <a class="struct" href="../../actix_web/middleware/identity/struct.IdentityService.html" title="struct actix_web::middleware::identity::IdentityService">IdentityService</a><T></code><td><div class='out-of-band'><a class='srclink' href='../../src/actix_web/middleware/identity.rs.html#180-200' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
||
<li><table class='table-display'><tbody><tr><td><code>impl<S: 'static, T: SessionBackend<S>> Middleware<S> for <a class="struct" href="../../actix_web/middleware/session/struct.SessionStorage.html" title="struct actix_web::middleware::session::SessionStorage">SessionStorage</a><T, S></code><td><div class='out-of-band'><a class='srclink' href='../../src/actix_web/middleware/session.rs.html#248-270' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
||
</ul><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
||
src="../../implementors/actix_web/middleware/trait.Middleware.js">
|
||
</script></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> |