<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="API documentation for the Rust `Drain` struct in crate `actix_web`."><metaname="keywords"content="rust, rustlang, rust-lang, Drain"><title>actix_web::dev::Drain - Rust</title><linkrel="stylesheet"type="text/css"href="../../normalize.css"><linkrel="stylesheet"type="text/css"href="../../rustdoc.css"id="mainThemeStyle"><linkrel="stylesheet"type="text/css"href="../../dark.css"><linkrel="stylesheet"type="text/css"href="../../light.css"id="themeStyle"><scriptsrc="../../storage.js"></script></head><bodyclass="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="sidebar"><divclass="sidebar-menu">☰</div><pclass='location'>Struct Drain</p><divclass="sidebar-elems"><divclass="block items"><aclass="sidebar-title"href="#methods">Methods</a><divclass="sidebar-links"><ahref="#method.new">new</a></div><aclass="sidebar-title"href="#implementations">Trait Implementations</a><divclass="sidebar-links"><ahref="#impl-ActorFuture">ActorFuture</a></div><aclass="sidebar-title"href="#synthetic-implementations">Auto Trait Implementations</a><divclass="sidebar-links"><ahref="#impl-Send">Send</a><ahref="#impl-Sync">Sync</a></div></div><pclass='location'><ahref='../index.html'>actix_web</a>::<wbr><ahref='index.html'>dev</a></p><script>window.sidebarCurrent={name:'Drain',ty:'struct',relpath:''};</script><scriptdefersrc="sidebar-items.js"></script></div></nav><divclass="theme-picker"><buttonid="theme-picker"aria-label="Pick another theme!"><imgsrc="../../brush.svg"width="18"alt="Pick another theme!"></button><divid="theme-choices"></div></div><scriptsrc="../../theme.js"></script><navclass="sub"><formclass="search-form js-only"><divclass="search-container"><inputclass="search-input"name="search"autocomplete="off"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"><aid="settings-menu"href="../../settings.html"><imgsrc="../../wheel.svg"width="18"alt="Change settings"></a></div></form></nav><sectionid="main"class="content"><h1class='fqn'><spanclass='in-band'>Struct <ahref='../index.html'>actix_web</a>::<wbr><ahref='index.html'>dev</a>::<wbr><aclass="struct"href=''>Drain</a></span><spanclass='out-of-band'><spanid='render-detail'><aid="toggle-all-docs"href="javascript:void(0)"title="collapse all docs">[<spanclass='inner'>−</span>]</a></span><aclass='srclink'href='../../src/actix_web/context.rs.html#268-271'title='goto source code'>[src]</a></span></h1><divclass="docblock type-decl"><preclass='rust struct'>pub struct Drain<A> { /* fields omitted */ }</pre></div><divclass='docblock'><p>Consume a future</p>
</div>
<h2id='methods'class='small-section-header'>
Methods<ahref='#methods'class='anchor'></a>
</h2>
<h3id='impl'class='impl'><spanclass='in-band'><tableclass='table-display'><tbody><tr><td><code>impl<A><aclass="struct"href="../../actix_web/dev/struct.Drain.html"title="struct actix_web::dev::Drain">Drain</a><A></code><ahref='#impl'class='anchor'></a></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='../../src/actix_web/context.rs.html#273-281'title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><divclass='impl-items'><h4id='method.new'class="method"><spanid='new.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>pub fn <ahref='#method.new'class='fnname'>new</a>(fut: <aclass="struct"href="https://docs.rs/futures/0.1/futures/sync/oneshot/struct.Receiver.html"title="struct futures::sync::oneshot::Receiver">Receiver</a><<aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>) -> Self</code></span></td><td><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='../../src/actix_web/context.rs.html#275-280'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><divclass='docblock'><p>Create a drain from a future</p>
<divclass='docblock'><p>The type of value that this future will resolved with if it is successful. <ahref="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Item">Read more</a></p>
<divclass='docblock'><p>The type of error that this future will resolve with if it fails in a normal fashion. <ahref="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Error">Read more</a></p>
</div><h4id='method.poll'class="method"><spanid='poll.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>fn <ahref='../../actix_web/actix/actix/trait.ActorFuture.html#tymethod.poll'class='fnname'>poll</a>(<br> &mut self, <br> _: <aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>A, <br> _: &mut <Self::<aclass="type"href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Actor"title="type actix_web::actix::actix::ActorFuture::Actor">Actor</a> as <aclass="trait"href="../../actix_web/actix/actix/trait.Actor.html"title="trait actix_web::actix::actix::Actor">Actor</a>>::<aclass="type"href="../../actix_web/actix/actix/trait.Actor.html#associatedtype.Context"title="type actix_web::actix::actix::Actor::Context">Context</a><br>) -><aclass="type"href="https://docs.rs/futures/0.1/futures/poll/type.Poll.html"title="type futures::poll::Poll">Poll</a><Self::<aclass="type"href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Item"title="type actix_web::actix::actix::ActorFuture::Item">Item</a>, Self::<aclass="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><spanclass='out-of-band'><divclass='ghost'></div><aclass='srclink'href='../../src/actix_web/context.rs.html#289-293'title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4id='method.map'class="method"><spanid='map.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>fn <ahref='../../actix_web/actix/actix/trait.ActorFuture.html#method.map'class='fnname'>map</a><F, U>(self, f: F) -><aclass="struct"href="../../actix_web/actix/actix/fut/struct.Map.html"title="struct actix_web::actix::actix::fut::Map">Map</a><Self, F><spanclass="where fmt-newline">where<br> F: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html"title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<aclass="type"href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Item"title="type actix_web::actix::actix::ActorFuture::Item">Item</a>, &mut Self::<aclass="type"href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Actor"title="type actix_web::actix::actix::ActorFuture::Actor">Actor</a>, &mut <Self::<aclass="type"href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Actor"title="type actix_web::actix::actix::ActorFuture::Actor">Actor</a> as <aclass="trait"href="../../actix_web/actix/actix/trait.Actor.html"title="trait actix_web::actix::actix::Actor">Actor</a>>::<aclass="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><divclass='docblock'><p>Map this future's result to a different type, returning a new future of the resulting type. <ahref="../../actix_web/actix/actix/trait.ActorFuture.html#method.map">Read more</a></p>
</div><h4id='method.map_err'class="method"><spanid='map_err.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>fn <ahref='../../actix_web/actix/actix/trait.ActorFuture.html#method.map_err'class='fnname'>map_err</a><F, E>(self, f: F) -><aclass="struct"href="../../actix_web/actix/actix/fut/struct.MapErr.html"title="struct actix_web::actix::actix::fut::MapErr">MapErr</a><Self, F><spanclass="where fmt-newline">where<br> F: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html"title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<aclass="type"href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Error"title="type actix_web::actix::actix::ActorFuture::Error">Error</a>, &mut Self::<aclass="type"href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Actor"title="type actix_web::actix::actix::ActorFuture::Actor">Actor</a>, &mut <Self::<aclass="type"href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Actor"title="type actix_web::actix::actix::ActorFuture::Actor">Actor</a> as <aclass="trait"href="../../actix_web/actix/actix/trait.Actor.html"title="trait actix_web::actix::actix::Actor">Actor</a>>::<aclass="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><divclass='docblock'><p>Map this future's error to a different error, returning a new future.</p>
</div><h4id='method.drop_err'class="method"><spanid='drop_err.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>fn <ahref='../../actix_web/actix/actix/trait.ActorFuture.html#method.drop_err'class='fnname'>drop_err</a>(self) -><aclass="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><divclass='docblock'><p>Drop this future's error, returning a new future.</p>
</div><h4id='method.from_err'class="method"><spanid='from_err.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>fn <ahref='../../actix_web/actix/actix/trait.ActorFuture.html#method.from_err'class='fnname'>from_err</a><E>(self) -><aclass="struct"href="../../actix_web/actix/actix/fut/struct.FromErr.html"title="struct actix_web::actix::actix::fut::FromErr">FromErr</a><Self, E><spanclass="where fmt-newline">where<br> E: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html"title="trait core::convert::From">From</a><Self::<aclass="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><divclass='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. <ahref="../../actix_web/actix/actix/trait.ActorFuture.html#method.from_err">Read more</a></p>
</div><h4id='method.then'class="method"><spanid='then.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>fn <ahref='../../actix_web/actix/actix/trait.ActorFuture.html#method.then'class='fnname'>then</a><F, B>(self, f: F) -><aclass="struct"href="../../actix_web/actix/actix/fut/struct.Then.html"title="struct actix_web::actix::actix::fut::Then">Then</a><Self, B, F><spanclass="where fmt-newline">where<br> B: <aclass="trait"href="../../actix_web/actix/actix/fut/trait.IntoActorFuture.html"title="trait actix_web::actix::actix::fut::IntoActorFuture">IntoActorFuture</a><Actor = Self::<aclass="type"href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Actor"title="type actix_web::actix::actix::ActorFuture::Actor">Actor</a>>,<br> F: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html"title="trait core::ops::function::FnOnce">FnOnce</a>(<aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><Self::<aclass="type"href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Item"title="type actix_web::actix::actix::ActorFuture::Item">Item</a>, Self::<aclass="type"href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Error"title="type actix_web::actix::actix::ActorFuture::Error">Error</a>>, &mut Self::<aclass="type"href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Actor"title="type actix_web::actix::actix::ActorFuture::Actor">Actor</a>, &mut <Self::<aclass="type"href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Actor"title="type actix_web::actix::actix::ActorFuture::Actor">Actor</a> as <aclass="trait"href="../../actix_web/actix/actix/trait.Actor.html"title="trait actix_web::actix::actix::Actor">Actor</a>>::<aclass="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><divclass='docblock'><p>Chain on a computation for when a future finished, passing the result of the future to the provided closure <code>f</code>. <ahref="../../actix_web/actix/actix/trait.ActorFuture.html#method.then">Read more</a></p>
</div><h4id='method.and_then'class="method"><spanid='and_then.v'class='invisible'><tableclass='table-display'><tbody><tr><td><code>fn <ahref='../../actix_web/actix/actix/trait.ActorFuture.html#method.and_then'class='fnname'>and_then</a><F, B>(self, f: F) -><aclass="struct"href="../../actix_web/actix/actix/fut/struct.AndThen.html"title="struct actix_web::actix::actix::fut::AndThen">AndThen</a><Self, B, F><spanclass="where fmt-newline">where<br> B: <aclass="trait"href="../../actix_web/actix/actix/fut/trait.IntoActorFuture.html"title="trait actix_web::actix::actix::fut::IntoActorFuture">IntoActorFuture</a><Error = Self::<aclass="type"href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Error"title="type actix_web::actix::actix::ActorFuture::Error">Error</a>, Actor = Self::<aclass="type"href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Actor"title="type actix_web::actix::actix::ActorFuture::Actor">Actor</a>>,<br> F: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html"title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<aclass="type"href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Item"title="type actix_web::actix::actix::ActorFuture::Item">Item</a>, &mut Self::<aclass="type"href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Actor"title="type actix_web::actix::actix::ActorFuture::Actor">Actor</a>, &mut <Self::<aclass="type"href="../../actix_web/actix/actix/trait.ActorFuture.html#associatedtype.Actor"title="type actix_web::actix::actix::ActorFuture::Actor">Actor</a> as <aclass="trait"href="../../actix_web/actix/actix/trait.Actor.html"title="trait actix_web::actix::actix::Actor">Actor</a>>::<aclass="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><divclass='docblock'><p>Execute another future after this one has resolved successfully.</p>
Auto Trait Implementations<ahref='#synthetic-implementations'class='anchor'></a>
</h2>
<divid='synthetic-implementations-list'>
<h3id='impl-Send'class='impl'><spanclass='in-band'><tableclass='table-display'><tbody><tr><td><code>impl<A><aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html"title="trait core::marker::Send">Send</a> for <aclass="struct"href="../../actix_web/dev/struct.Drain.html"title="struct actix_web::dev::Drain">Drain</a><A><spanclass="where fmt-newline">where<br> A: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html"title="trait core::marker::Send">Send</a>, </span></code><ahref='#impl-Send'class='anchor'></a></span></td><td><spanclass='out-of-band'></span></td></tr></tbody></table></h3><divclass='impl-items'></div><h3id='impl-Sync'class='impl'><spanclass='in-band'><tableclass='table-display'><tbody><tr><td><code>impl<A><aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html"title="trait core::marker::Sync">Sync</a> for <aclass="struct"href="../../actix_web/dev/struct.Drain.html"title="struct actix_web::dev::Drain">Drain</a><A><spanclass="where fmt-newline">where<br> A: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html"title="trait core::marker::Sync">Sync</a>, </span></code><ahref='#impl-Sync'class='anchor'></a></span></td><td><spanclass='out-of-band'></span></td></tr></tbody></table></h3><divclass='impl-items'></div></div></section><sectionid="search"class="content hidden"></section><sectionclass="footer"></section><asideid="help"class="hidden"><div><h1class="hidden">Help</h1><divclass="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><divclass="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><scriptsrc="../../aliases.js"></script><scriptsrc="../../main.js"></script><scriptdefersrc="../../search-index.js"></script></body></html>
