mirror of
https://github.com/actix/actix-website
synced 2024-11-25 01:02:58 +01:00
29 lines
22 KiB
HTML
29 lines
22 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 `Drain` struct in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, Drain"><title>actix_web::dev::Drain - 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 Drain</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></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-ActorFuture">ActorFuture</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></div><p class='location'><a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>dev</a></p><script>window.sidebarCurrent = {name: 'Drain', 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='in-band'>Struct <a href='../index.html'>actix_web</a>::<wbr><a href='index.html'>dev</a>::<wbr><a class="struct" href=''>Drain</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/context.rs.html#268-271' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct Drain<A> { /* fields omitted */ }</pre></div><div class='docblock'><p>Consume a future</p>
|
||
</div>
|
||
<h2 id='methods' class='small-section-header'>
|
||
Methods<a href='#methods' class='anchor'></a>
|
||
</h2>
|
||
<h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<A> <a class="struct" href="../../actix_web/dev/struct.Drain.html" title="struct actix_web::dev::Drain">Drain</a><A></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/context.rs.html#273-281' 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>(fut: <a class="struct" href="https://docs.rs/futures/0.1/futures/sync/oneshot/struct.Receiver.html" title="struct futures::sync::oneshot::Receiver">Receiver</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/context.rs.html#275-280' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create a drain from a future</p>
|
||
</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-ActorFuture' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<A: <a class="trait" href="../../actix_web/actix/actix/trait.Actor.html" title="trait actix_web::actix::actix::Actor">Actor</a>> <a class="trait" href="../../actix_web/actix/actix/trait.ActorFuture.html" title="trait actix_web::actix::actix::ActorFuture">ActorFuture</a> for <a class="struct" href="../../actix_web/dev/struct.Drain.html" title="struct actix_web::dev::Drain">Drain</a><A></code><a href='#impl-ActorFuture' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/context.rs.html#283-294' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Item' class="type"><span id='Item.t' class='invisible'><code>type <a href='../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Item' class="type">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a></code></span></h4>
|
||
<div class='docblock'><p>The type of value that this future will resolved with if it is successful. <a href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Item">Read more</a></p>
|
||
</div><h4 id='associatedtype.Error' class="type"><span id='Error.t' class='invisible'><code>type <a href='../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Error' class="type">Error</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a></code></span></h4>
|
||
<div class='docblock'><p>The type of error that this future will resolve with if it fails in a normal fashion. <a href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Error">Read more</a></p>
|
||
</div><h4 id='associatedtype.Actor' class="type"><span id='Actor.t' class='invisible'><code>type <a href='../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Actor' class="type">Actor</a> = A</code></span></h4>
|
||
<div class='docblock'><p>The actor within which this future runs</p>
|
||
</div><h4 id='method.poll' class="method"><span id='poll.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/trait.ActorFuture.html#tymethod.poll' class='fnname'>poll</a>(<br> &mut self, <br> _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>A, <br> _: &mut <Self::<a class="type" href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Actor" title="type actix_web::actix::actix::ActorFuture::Actor">Actor</a> as <a class="trait" href="../../actix_web/actix/actix/trait.Actor.html" title="trait actix_web::actix::actix::Actor">Actor</a>>::<a class="type" href="../../actix_web/actix/actix/trait.Actor.html#associatedtype.Context" title="type actix_web::actix::actix::Actor::Context">Context</a><br>) -> <a class="type" href="https://docs.rs/futures/0.1/futures/poll/type.Poll.html" title="type futures::poll::Poll">Poll</a><Self::<a class="type" href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Item" title="type actix_web::actix::actix::ActorFuture::Item">Item</a>, Self::<a class="type" href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Error" title="type actix_web::actix::actix::ActorFuture::Error">Error</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/actix_web/context.rs.html#289-293' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.map' class="method"><span id='map.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/trait.ActorFuture.html#method.map' class='fnname'>map</a><F, U>(self, f: F) -> <a class="struct" href="../../actix_web/actix/actix/fut/struct.Map.html" title="struct actix_web::actix::actix::fut::Map">Map</a><Self, F> <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>(Self::<a class="type" href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Item" title="type actix_web::actix::actix::ActorFuture::Item">Item</a>, &mut Self::<a class="type" href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Actor" title="type actix_web::actix::actix::ActorFuture::Actor">Actor</a>, &mut <Self::<a class="type" href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Actor" title="type actix_web::actix::actix::ActorFuture::Actor">Actor</a> as <a class="trait" href="../../actix_web/actix/actix/trait.Actor.html" title="trait actix_web::actix::actix::Actor">Actor</a>>::<a class="type" href="../../actix_web/actix/actix/trait.Actor.html#associatedtype.Context" title="type actix_web::actix::actix::Actor::Context">Context</a>) -> U, </span></code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Map this future's result to a different type, returning a new future of the resulting type. <a href="../../actix_web/actix/actix/trait.ActorFuture.html#method.map">Read more</a></p>
|
||
</div><h4 id='method.map_err' class="method"><span id='map_err.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/trait.ActorFuture.html#method.map_err' class='fnname'>map_err</a><F, E>(self, f: F) -> <a class="struct" href="../../actix_web/actix/actix/fut/struct.MapErr.html" title="struct actix_web::actix::actix::fut::MapErr">MapErr</a><Self, F> <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>(Self::<a class="type" href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Error" title="type actix_web::actix::actix::ActorFuture::Error">Error</a>, &mut Self::<a class="type" href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Actor" title="type actix_web::actix::actix::ActorFuture::Actor">Actor</a>, &mut <Self::<a class="type" href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Actor" title="type actix_web::actix::actix::ActorFuture::Actor">Actor</a> as <a class="trait" href="../../actix_web/actix/actix/trait.Actor.html" title="trait actix_web::actix::actix::Actor">Actor</a>>::<a class="type" href="../../actix_web/actix/actix/trait.Actor.html#associatedtype.Context" title="type actix_web::actix::actix::Actor::Context">Context</a>) -> E, </span></code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Map this future's error to a different error, returning a new future.</p>
|
||
</div><h4 id='method.drop_err' class="method"><span id='drop_err.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/trait.ActorFuture.html#method.drop_err' class='fnname'>drop_err</a>(self) -> <a class="struct" href="../../actix_web/actix/actix/fut/struct.DropErr.html" title="struct actix_web::actix::actix::fut::DropErr">DropErr</a><Self></code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Drop this future's error, returning a new future.</p>
|
||
</div><h4 id='method.from_err' class="method"><span id='from_err.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/trait.ActorFuture.html#method.from_err' class='fnname'>from_err</a><E>(self) -> <a class="struct" href="../../actix_web/actix/actix/fut/struct.FromErr.html" title="struct actix_web::actix::actix::fut::FromErr">FromErr</a><Self, E> <span class="where fmt-newline">where<br> E: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><Self::<a class="type" href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Error" title="type actix_web::actix::actix::ActorFuture::Error">Error</a>>, </span></code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Map this future's error to any error implementing <code>From</code> for this future's <code>Error</code>, returning a new future. <a href="../../actix_web/actix/actix/trait.ActorFuture.html#method.from_err">Read more</a></p>
|
||
</div><h4 id='method.then' class="method"><span id='then.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/trait.ActorFuture.html#method.then' class='fnname'>then</a><F, B>(self, f: F) -> <a class="struct" href="../../actix_web/actix/actix/fut/struct.Then.html" title="struct actix_web::actix::actix::fut::Then">Then</a><Self, B, F> <span class="where fmt-newline">where<br> B: <a class="trait" href="../../actix_web/actix/actix/fut/trait.IntoActorFuture.html" title="trait actix_web::actix::actix::fut::IntoActorFuture">IntoActorFuture</a><Actor = Self::<a class="type" href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Actor" title="type actix_web::actix::actix::ActorFuture::Actor">Actor</a>>,<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="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="type" href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Item" title="type actix_web::actix::actix::ActorFuture::Item">Item</a>, Self::<a class="type" href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Error" title="type actix_web::actix::actix::ActorFuture::Error">Error</a>>, &mut Self::<a class="type" href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Actor" title="type actix_web::actix::actix::ActorFuture::Actor">Actor</a>, &mut <Self::<a class="type" href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Actor" title="type actix_web::actix::actix::ActorFuture::Actor">Actor</a> as <a class="trait" href="../../actix_web/actix/actix/trait.Actor.html" title="trait actix_web::actix::actix::Actor">Actor</a>>::<a class="type" href="../../actix_web/actix/actix/trait.Actor.html#associatedtype.Context" title="type actix_web::actix::actix::Actor::Context">Context</a>) -> B, </span></code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Chain on a computation for when a future finished, passing the result of the future to the provided closure <code>f</code>. <a href="../../actix_web/actix/actix/trait.ActorFuture.html#method.then">Read more</a></p>
|
||
</div><h4 id='method.and_then' class="method"><span id='and_then.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/trait.ActorFuture.html#method.and_then' class='fnname'>and_then</a><F, B>(self, f: F) -> <a class="struct" href="../../actix_web/actix/actix/fut/struct.AndThen.html" title="struct actix_web::actix::actix::fut::AndThen">AndThen</a><Self, B, F> <span class="where fmt-newline">where<br> B: <a class="trait" href="../../actix_web/actix/actix/fut/trait.IntoActorFuture.html" title="trait actix_web::actix::actix::fut::IntoActorFuture">IntoActorFuture</a><Error = Self::<a class="type" href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Error" title="type actix_web::actix::actix::ActorFuture::Error">Error</a>, Actor = Self::<a class="type" href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Actor" title="type actix_web::actix::actix::ActorFuture::Actor">Actor</a>>,<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>(Self::<a class="type" href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Item" title="type actix_web::actix::actix::ActorFuture::Item">Item</a>, &mut Self::<a class="type" href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Actor" title="type actix_web::actix::actix::ActorFuture::Actor">Actor</a>, &mut <Self::<a class="type" href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Actor" title="type actix_web::actix::actix::ActorFuture::Actor">Actor</a> as <a class="trait" href="../../actix_web/actix/actix/trait.Actor.html" title="trait actix_web::actix::actix::Actor">Actor</a>>::<a class="type" href="../../actix_web/actix/actix/trait.Actor.html#associatedtype.Context" title="type actix_web::actix::actix::Actor::Context">Context</a>) -> B, </span></code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Execute another future after this one has resolved successfully.</p>
|
||
</div><h4 id='method.timeout' class="method"><span id='timeout.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../actix_web/actix/actix/trait.ActorFuture.html#method.timeout' class='fnname'>timeout</a>(self, timeout: <a class="struct" href="https://doc.rust-lang.org/nightly/core/time/struct.Duration.html" title="struct core::time::Duration">Duration</a>, err: Self::<a class="type" href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Error" title="type actix_web::actix::actix::ActorFuture::Error">Error</a>) -> <a class="struct" href="../../actix_web/actix/actix/fut/struct.Timeout.html" title="struct actix_web::actix::actix::fut::Timeout">Timeout</a><Self></code></td><td></td></tr></tbody></table></span></h4><div class='docblock'><p>Add timeout to futures chain. <a href="../../actix_web/actix/actix/trait.ActorFuture.html#method.timeout">Read more</a></p>
|
||
</div></div></div>
|
||
<h2 id='synthetic-implementations' class='small-section-header'>
|
||
Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a>
|
||
</h2>
|
||
<div id='synthetic-implementations-list'>
|
||
<h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<A> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../actix_web/dev/struct.Drain.html" title="struct actix_web::dev::Drain">Drain</a><A> <span class="where fmt-newline">where<br> A: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></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<A> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../actix_web/dev/struct.Drain.html" title="struct actix_web::dev::Drain">Drain</a><A> <span class="where fmt-newline">where<br> A: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>, </span></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></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> |