144 lines
No EOL
9.2 KiB
HTML
144 lines
No EOL
9.2 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 `BeforeMiddleware` trait in crate `iron`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, BeforeMiddleware">
|
||
|
||
<title>iron::middleware::BeforeMiddleware - Rust</title>
|
||
|
||
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
|
||
<link rel="stylesheet" type="text/css" href="../../main.css">
|
||
|
||
|
||
<link rel="shortcut icon" href="https://avatars0.githubusercontent.com/u/7853871?s=256">
|
||
|
||
</head>
|
||
<body class="rustdoc">
|
||
<!--[if lte IE 8]>
|
||
<div class="warning">
|
||
This old browser is unsupported and will most likely display funky
|
||
things.
|
||
</div>
|
||
<![endif]-->
|
||
|
||
|
||
|
||
<nav class="sidebar">
|
||
<a href='../../iron/index.html'><img src='https://avatars0.githubusercontent.com/u/7853871?s=128' alt='logo' width='100'></a>
|
||
<p class='location'><a href='../index.html'>iron</a>::<wbr><a href='index.html'>middleware</a></p><script>window.sidebarCurrent = {name: 'BeforeMiddleware', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script>
|
||
</nav>
|
||
|
||
<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">
|
||
</div>
|
||
</form>
|
||
</nav>
|
||
|
||
<section id='main' class="content trait">
|
||
<h1 class='fqn'><span class='in-band'>Trait <a href='../index.html'>iron</a>::<wbr><a href='index.html'>middleware</a>::<wbr><a class='trait' href=''>BeforeMiddleware</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 id='src-81' class='srclink' href='../../src/iron/middleware/mod.rs.html#73-83' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust trait'>pub trait BeforeMiddleware: <a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Send.html' title='core::marker::Send'>Send</a> + <a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html' title='core::marker::Sync'>Sync</a> + 'static {
|
||
fn <a href='#method.before' class='fnname'>before</a>(&self, _: &mut <a class='struct' href='../../iron/request/struct.Request.html' title='iron::request::Request'>Request</a>) -> <a class='type' href='../../iron/type.IronResult.html' title='iron::IronResult'>IronResult</a><<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.tuple.html'>()</a>> { ... }
|
||
fn <a href='#method.catch' class='fnname'>catch</a>(&self, _: &mut <a class='struct' href='../../iron/request/struct.Request.html' title='iron::request::Request'>Request</a>, err: <a class='struct' href='../../iron/error/struct.IronError.html' title='iron::error::IronError'>IronError</a>) -> <a class='type' href='../../iron/type.IronResult.html' title='iron::IronResult'>IronResult</a><<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.tuple.html'>()</a>> { ... }
|
||
}</pre><div class='docblock'><p><code>BeforeMiddleware</code> are fired before a <code>Handler</code> is called inside of a Chain.</p>
|
||
|
||
<p><code>BeforeMiddleware</code> are responsible for doing request pre-processing that requires
|
||
the ability to change control-flow, such as authorization middleware, or for editing
|
||
the request by modifying the headers.</p>
|
||
|
||
<p><code>BeforeMiddleware</code> only have access to the Request, if you need to modify or read
|
||
a Response, you will need <code>AfterMiddleware</code>. Middleware which wishes to send an
|
||
early response that is not an error cannot be <code>BeforeMiddleware</code>, but should
|
||
instead be <code>AroundMiddleware</code>.</p>
|
||
</div>
|
||
<h2 id='provided-methods'>Provided Methods</h2>
|
||
<div class='methods'>
|
||
<h3 id='method.before' class='method stab '><code>fn <a href='#method.before' class='fnname'>before</a>(&self, _: &mut <a class='struct' href='../../iron/request/struct.Request.html' title='iron::request::Request'>Request</a>) -> <a class='type' href='../../iron/type.IronResult.html' title='iron::IronResult'>IronResult</a><<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.tuple.html'>()</a>></code></h3><div class='docblock'><p>Do whatever work this middleware should do with a <code>Request</code> object.</p>
|
||
</div><h3 id='method.catch' class='method stab '><code>fn <a href='#method.catch' class='fnname'>catch</a>(&self, _: &mut <a class='struct' href='../../iron/request/struct.Request.html' title='iron::request::Request'>Request</a>, err: <a class='struct' href='../../iron/error/struct.IronError.html' title='iron::error::IronError'>IronError</a>) -> <a class='type' href='../../iron/type.IronResult.html' title='iron::IronResult'>IronResult</a><<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.tuple.html'>()</a>></code></h3><div class='docblock'><p>Respond to an error thrown by a previous <code>BeforeMiddleware</code>.</p>
|
||
|
||
<p>Returning a <code>Ok</code> will cause the request to resume the normal flow at the
|
||
next <code>BeforeMiddleware</code>, or if this was the last <code>BeforeMiddleware</code>,
|
||
at the <code>Handler</code>.</p>
|
||
</div></div>
|
||
<h2 id='implementors'>Implementors</h2>
|
||
<ul class='item-list' id='implementors-list'>
|
||
<li><code>impl<F> BeforeMiddleware for F <span class='where'>where F: <a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Send.html' title='core::marker::Send'>Send</a> + <a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html' title='core::marker::Sync'>Sync</a> + 'static + <a class='trait' href='https://doc.rust-lang.org/nightly/core/ops/trait.Fn.html' title='core::ops::Fn'>Fn</a>(&mut <a class='struct' href='../../iron/request/struct.Request.html' title='iron::request::Request'>Request</a>) -> <a class='type' href='../../iron/type.IronResult.html' title='iron::IronResult'>IronResult</a><<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.tuple.html'>()</a>></span></code></li>
|
||
<li><code>impl BeforeMiddleware for <a class='struct' href='https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html' title='alloc::boxed::Box'>Box</a><<a class='trait' href='../../iron/middleware/trait.BeforeMiddleware.html' title='iron::middleware::BeforeMiddleware'>BeforeMiddleware</a>></code></li>
|
||
<li><code>impl<T> BeforeMiddleware for <a class='struct' href='https://doc.rust-lang.org/nightly/alloc/arc/struct.Arc.html' title='alloc::arc::Arc'>Arc</a><T> <span class='where'>where T: <a class='trait' href='../../iron/middleware/trait.BeforeMiddleware.html' title='iron::middleware::BeforeMiddleware'>BeforeMiddleware</a></span></code></li>
|
||
</ul><script type="text/javascript" async
|
||
src="../../implementors/iron/middleware/trait.BeforeMiddleware.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>?</dt>
|
||
<dd>Show this help dialog</dd>
|
||
<dt>S</dt>
|
||
<dd>Focus the search field</dd>
|
||
<dt>⇤</dt>
|
||
<dd>Move up in search results</dd>
|
||
<dt>⇥</dt>
|
||
<dd>Move down in search results</dd>
|
||
<dt>⏎</dt>
|
||
<dd>Go to active search result</dd>
|
||
<dt>+</dt>
|
||
<dd>Collapse/expand 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>
|
||
</div>
|
||
</div>
|
||
</aside>
|
||
|
||
|
||
|
||
<script>
|
||
window.rootPath = "../../";
|
||
window.currentCrate = "iron";
|
||
window.playgroundUrl = "";
|
||
</script>
|
||
<script src="../../jquery.js"></script>
|
||
<script src="../../main.js"></script>
|
||
|
||
<script defer src="../../search-index.js"></script>
|
||
</body>
|
||
</html> |