mentat/docs/apis/rust/tokio/prelude/stream/struct.SplitSink.html
2018-06-22 12:08:32 +01:00

162 lines
No EOL
30 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `SplitSink` struct in crate `tokio`.">
<meta name="keywords" content="rust, rustlang, rust-lang, SplitSink">
<title>tokio::prelude::stream::SplitSink - 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">&#9776;</div>
<p class='location'>Struct SplitSink</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.reunite">reunite</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Sink">Sink</a><a href="#impl-Debug">Debug</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'>tokio</a>::<wbr><a href='../index.html'>prelude</a>::<wbr><a href='index.html'>stream</a></p><script>window.sidebarCurrent = {name: 'SplitSink', 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">
</div>
</form>
</nav>
<section id='main' class="content"><h1 class='fqn'><span class='in-band'>Struct <a href='../../index.html'>tokio</a>::<wbr><a href='../index.html'>prelude</a>::<wbr><a href='index.html'>stream</a>::<wbr><a class="struct" href=''>SplitSink</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'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../../../src/futures/stream/split.rs.html#35' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct SplitSink&lt;S&gt;(_);</pre></div><div class='docblock'><p>A <code>Sink</code> part of the split pair</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&lt;S&gt; <a class="struct" href="../../../tokio/prelude/stream/struct.SplitSink.html" title="struct tokio::prelude::stream::SplitSink">SplitSink</a>&lt;S&gt;</code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/split.rs.html#37-46' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.reunite' class="method"><span id='reunite.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.reunite' class='fnname'>reunite</a>(self, other: <a class="struct" href="../../../tokio/prelude/stream/struct.SplitStream.html" title="struct tokio::prelude::stream::SplitStream">SplitStream</a>&lt;S&gt;) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;S, <a class="struct" href="../../../tokio/prelude/stream/struct.ReuniteError.html" title="struct tokio::prelude::stream::ReuniteError">ReuniteError</a>&lt;S&gt;&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/split.rs.html#41-45' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Attempts to put the two &quot;halves&quot; of a split <code>Stream + Sink</code> back
together. Succeeds only if the <code>SplitStream&lt;S&gt;</code> and <code>SplitSink&lt;S&gt;</code> are
a matching pair originating from the same call to <code>Stream::split</code>.</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-Sink' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl&lt;S&gt; <a class="trait" href="../../../tokio/prelude/trait.Sink.html" title="trait tokio::prelude::Sink">Sink</a> for <a class="struct" href="../../../tokio/prelude/stream/struct.SplitSink.html" title="struct tokio::prelude::stream::SplitSink">SplitSink</a>&lt;S&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;S: <a class="trait" href="../../../tokio/prelude/trait.Sink.html" title="trait tokio::prelude::Sink">Sink</a>,&nbsp;</span></code><a href='#impl-Sink' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/split.rs.html#48-74' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.SinkItem' class="type"><span id='SinkItem.t' class='invisible'><code>type <a href='../../../tokio/prelude/trait.Sink.html#associatedtype.SinkItem' class="type">SinkItem</a> = &lt;S as <a class="trait" href="../../../tokio/prelude/trait.Sink.html" title="trait tokio::prelude::Sink">Sink</a>&gt;::<a class="type" href="../../../tokio/prelude/trait.Sink.html#associatedtype.SinkItem" title="type tokio::prelude::Sink::SinkItem">SinkItem</a></code></span></h4>
<div class='docblock'><p>The type of value that the sink accepts.</p>
</div><h4 id='associatedtype.SinkError' class="type"><span id='SinkError.t' class='invisible'><code>type <a href='../../../tokio/prelude/trait.Sink.html#associatedtype.SinkError' class="type">SinkError</a> = &lt;S as <a class="trait" href="../../../tokio/prelude/trait.Sink.html" title="trait tokio::prelude::Sink">Sink</a>&gt;::<a class="type" href="../../../tokio/prelude/trait.Sink.html#associatedtype.SinkError" title="type tokio::prelude::Sink::SinkError">SinkError</a></code></span></h4>
<div class='docblock'><p>The type of value produced by the sink when an error occurs.</p>
</div><h4 id='method.start_send' class="method"><span id='start_send.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../../tokio/prelude/trait.Sink.html#tymethod.start_send' class='fnname'>start_send</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;mut self, <br>&nbsp;&nbsp;&nbsp;&nbsp;item: &lt;S as <a class="trait" href="../../../tokio/prelude/trait.Sink.html" title="trait tokio::prelude::Sink">Sink</a>&gt;::<a class="type" href="../../../tokio/prelude/trait.Sink.html#associatedtype.SinkItem" title="type tokio::prelude::Sink::SinkItem">SinkItem</a><br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="enum" href="../../../tokio/prelude/enum.AsyncSink.html" title="enum tokio::prelude::AsyncSink">AsyncSink</a>&lt;&lt;S as <a class="trait" href="../../../tokio/prelude/trait.Sink.html" title="trait tokio::prelude::Sink">Sink</a>&gt;::<a class="type" href="../../../tokio/prelude/trait.Sink.html#associatedtype.SinkItem" title="type tokio::prelude::Sink::SinkItem">SinkItem</a>&gt;, &lt;S as <a class="trait" href="../../../tokio/prelude/trait.Sink.html" title="trait tokio::prelude::Sink">Sink</a>&gt;::<a class="type" href="../../../tokio/prelude/trait.Sink.html#associatedtype.SinkError" title="type tokio::prelude::Sink::SinkError">SinkError</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/split.rs.html#52-59' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Begin the process of sending a value to the sink. <a href="../../../tokio/prelude/trait.Sink.html#tymethod.start_send">Read more</a></p>
</div><h4 id='method.poll_complete' class="method"><span id='poll_complete.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../../tokio/prelude/trait.Sink.html#tymethod.poll_complete' class='fnname'>poll_complete</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="enum" href="../../../tokio/prelude/enum.Async.html" title="enum tokio::prelude::Async">Async</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>&gt;, &lt;S as <a class="trait" href="../../../tokio/prelude/trait.Sink.html" title="trait tokio::prelude::Sink">Sink</a>&gt;::<a class="type" href="../../../tokio/prelude/trait.Sink.html#associatedtype.SinkError" title="type tokio::prelude::Sink::SinkError">SinkError</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/split.rs.html#61-66' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Flush all output from this sink, if necessary. <a href="../../../tokio/prelude/trait.Sink.html#tymethod.poll_complete">Read more</a></p>
</div><h4 id='method.close' class="method"><span id='close.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../../tokio/prelude/trait.Sink.html#method.close' class='fnname'>close</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="enum" href="../../../tokio/prelude/enum.Async.html" title="enum tokio::prelude::Async">Async</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>&gt;, &lt;S as <a class="trait" href="../../../tokio/prelude/trait.Sink.html" title="trait tokio::prelude::Sink">Sink</a>&gt;::<a class="type" href="../../../tokio/prelude/trait.Sink.html#associatedtype.SinkError" title="type tokio::prelude::Sink::SinkError">SinkError</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/split.rs.html#68-73' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>A method to indicate that no more values will ever be pushed into this sink. <a href="../../../tokio/prelude/trait.Sink.html#method.close">Read more</a></p>
</div><h4 id='method.wait' class="method"><span id='wait.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../../tokio/prelude/trait.Sink.html#method.wait' class='fnname'>wait</a>(self) -&gt; <a class="struct" href="../../../futures/sink/wait/struct.Wait.html" title="struct futures::sink::wait::Wait">Wait</a>&lt;Self&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/sink/mod.rs.html#296-300' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates a new object which will produce a synchronous sink. <a href="../../../tokio/prelude/trait.Sink.html#method.wait">Read more</a></p>
</div><h4 id='method.with' class="method"><span id='with.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../../tokio/prelude/trait.Sink.html#method.with' class='fnname'>with</a>&lt;U, F, Fut&gt;(self, f: F) -&gt; <a class="struct" href="../../../futures/sink/with/struct.With.html" title="struct futures::sink::with::With">With</a>&lt;Self, U, F, Fut&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;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>(U) -&gt; Fut,<br>&nbsp;&nbsp;&nbsp;&nbsp;Fut: <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a>&lt;Item = Self::<a class="type" href="../../../tokio/prelude/trait.Sink.html#associatedtype.SinkItem" title="type tokio::prelude::Sink::SinkItem">SinkItem</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;&lt;Fut as <a class="trait" href="../../../tokio/prelude/trait.IntoFuture.html" title="trait tokio::prelude::IntoFuture">IntoFuture</a>&gt;::<a class="type" href="../../../tokio/prelude/trait.IntoFuture.html#associatedtype.Error" title="type tokio::prelude::IntoFuture::Error">Error</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;Self::<a class="type" href="../../../tokio/prelude/trait.Sink.html#associatedtype.SinkError" title="type tokio::prelude::Sink::SinkError">SinkError</a>&gt;,&nbsp;</span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/sink/mod.rs.html#313-320' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Composes a function in front of the sink. <a href="../../../tokio/prelude/trait.Sink.html#method.with">Read more</a></p>
</div><h4 id='method.with_flat_map' class="method"><span id='with_flat_map.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../../tokio/prelude/trait.Sink.html#method.with_flat_map' class='fnname'>with_flat_map</a>&lt;U, F, St&gt;(self, f: F) -&gt; <a class="struct" href="../../../futures/sink/with_flat_map/struct.WithFlatMap.html" title="struct futures::sink::with_flat_map::WithFlatMap">WithFlatMap</a>&lt;Self, U, F, St&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;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>(U) -&gt; St,<br>&nbsp;&nbsp;&nbsp;&nbsp;St: <a class="trait" href="../../../tokio/prelude/stream/trait.Stream.html" title="trait tokio::prelude::stream::Stream">Stream</a>&lt;Item = Self::<a class="type" href="../../../tokio/prelude/trait.Sink.html#associatedtype.SinkItem" title="type tokio::prelude::Sink::SinkItem">SinkItem</a>, Error = Self::<a class="type" href="../../../tokio/prelude/trait.Sink.html#associatedtype.SinkError" title="type tokio::prelude::Sink::SinkError">SinkError</a>&gt;,&nbsp;</span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/sink/mod.rs.html#352-358' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Composes a function in front of the sink. <a href="../../../tokio/prelude/trait.Sink.html#method.with_flat_map">Read more</a></p>
</div><h4 id='method.sink_map_err' class="method"><span id='sink_map_err.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../../tokio/prelude/trait.Sink.html#method.sink_map_err' class='fnname'>sink_map_err</a>&lt;F, E&gt;(self, f: F) -&gt; <a class="struct" href="../../../futures/sink/map_err/struct.SinkMapErr.html" title="struct futures::sink::map_err::SinkMapErr">SinkMapErr</a>&lt;Self, F&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;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="../../../tokio/prelude/trait.Sink.html#associatedtype.SinkError" title="type tokio::prelude::Sink::SinkError">SinkError</a>) -&gt; E,&nbsp;</span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/sink/mod.rs.html#375-380' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Transforms the error returned by the sink.</p>
</div><h4 id='method.sink_from_err' class="method"><span id='sink_from_err.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../../tokio/prelude/trait.Sink.html#method.sink_from_err' class='fnname'>sink_from_err</a>&lt;E&gt;(self) -&gt; <a class="struct" href="../../../futures/sink/from_err/struct.SinkFromErr.html" title="struct futures::sink::from_err::SinkFromErr">SinkFromErr</a>&lt;Self, E&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;E: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;Self::<a class="type" href="../../../tokio/prelude/trait.Sink.html#associatedtype.SinkError" title="type tokio::prelude::Sink::SinkError">SinkError</a>&gt;,&nbsp;</span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/sink/mod.rs.html#386-390' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Map this sink's error to any error implementing <code>From</code> for this sink's <code>Error</code>, returning a new sink. <a href="../../../tokio/prelude/trait.Sink.html#method.sink_from_err">Read more</a></p>
</div><h4 id='method.buffer' class="method"><span id='buffer.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../../tokio/prelude/trait.Sink.html#method.buffer' class='fnname'>buffer</a>(self, amt: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -&gt; <a class="struct" href="../../../futures/sink/buffer/struct.Buffer.html" title="struct futures::sink::buffer::Buffer">Buffer</a>&lt;Self&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/sink/mod.rs.html#406-410' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Adds a fixed-size buffer to the current sink. <a href="../../../tokio/prelude/trait.Sink.html#method.buffer">Read more</a></p>
</div><h4 id='method.fanout' class="method"><span id='fanout.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../../tokio/prelude/trait.Sink.html#method.fanout' class='fnname'>fanout</a>&lt;S&gt;(self, other: S) -&gt; <a class="struct" href="../../../futures/sink/fanout/struct.Fanout.html" title="struct futures::sink::fanout::Fanout">Fanout</a>&lt;Self, S&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;S: <a class="trait" href="../../../tokio/prelude/trait.Sink.html" title="trait tokio::prelude::Sink">Sink</a>&lt;SinkItem = Self::<a class="type" href="../../../tokio/prelude/trait.Sink.html#associatedtype.SinkItem" title="type tokio::prelude::Sink::SinkItem">SinkItem</a>, SinkError = Self::<a class="type" href="../../../tokio/prelude/trait.Sink.html#associatedtype.SinkError" title="type tokio::prelude::Sink::SinkError">SinkError</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;Self::<a class="type" href="../../../tokio/prelude/trait.Sink.html#associatedtype.SinkItem" title="type tokio::prelude::Sink::SinkItem">SinkItem</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,&nbsp;</span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/sink/mod.rs.html#416-422' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Fanout items to multiple sinks. <a href="../../../tokio/prelude/trait.Sink.html#method.fanout">Read more</a></p>
</div><h4 id='method.flush' class="method"><span id='flush.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../../tokio/prelude/trait.Sink.html#method.flush' class='fnname'>flush</a>(self) -&gt; <a class="struct" href="../../../futures/sink/flush/struct.Flush.html" title="struct futures::sink::flush::Flush">Flush</a>&lt;Self&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/sink/mod.rs.html#430-434' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>A future that completes when the sink has finished processing all pending requests. <a href="../../../tokio/prelude/trait.Sink.html#method.flush">Read more</a></p>
</div><h4 id='method.send' class="method"><span id='send.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../../tokio/prelude/trait.Sink.html#method.send' class='fnname'>send</a>(self, item: Self::<a class="type" href="../../../tokio/prelude/trait.Sink.html#associatedtype.SinkItem" title="type tokio::prelude::Sink::SinkItem">SinkItem</a>) -&gt; <a class="struct" href="../../../futures/sink/send/struct.Send.html" title="struct futures::sink::send::Send">Send</a>&lt;Self&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/sink/mod.rs.html#444-448' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>A future that completes after the given item has been fully processed into the sink, including flushing. <a href="../../../tokio/prelude/trait.Sink.html#method.send">Read more</a></p>
</div><h4 id='method.send_all' class="method"><span id='send_all.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../../../tokio/prelude/trait.Sink.html#method.send_all' class='fnname'>send_all</a>&lt;S&gt;(self, stream: S) -&gt; <a class="struct" href="../../../futures/sink/send_all/struct.SendAll.html" title="struct futures::sink::send_all::SendAll">SendAll</a>&lt;Self, S&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;S: <a class="trait" href="../../../tokio/prelude/stream/trait.Stream.html" title="trait tokio::prelude::stream::Stream">Stream</a>&lt;Item = Self::<a class="type" href="../../../tokio/prelude/trait.Sink.html#associatedtype.SinkItem" title="type tokio::prelude::Sink::SinkItem">SinkItem</a>&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;Self::<a class="type" href="../../../tokio/prelude/trait.Sink.html#associatedtype.SinkError" title="type tokio::prelude::Sink::SinkError">SinkError</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;&lt;S as <a class="trait" href="../../../tokio/prelude/stream/trait.Stream.html" title="trait tokio::prelude::stream::Stream">Stream</a>&gt;::<a class="type" href="../../../tokio/prelude/stream/trait.Stream.html#associatedtype.Error" title="type tokio::prelude::stream::Stream::Error">Error</a>&gt;,&nbsp;</span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/sink/mod.rs.html#464-470' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>A future that completes after the given stream has been fully processed into the sink, including flushing. <a href="../../../tokio/prelude/trait.Sink.html#method.send_all">Read more</a></p>
</div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl&lt;S&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../../tokio/prelude/stream/struct.SplitSink.html" title="struct tokio::prelude::stream::SplitSink">SplitSink</a>&lt;S&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>,&nbsp;</span></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/split.rs.html#34' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, __arg_0: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../../src/futures/stream/split.rs.html#34' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">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&lt;S&gt; <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="../../../tokio/prelude/stream/struct.SplitSink.html" title="struct tokio::prelude::stream::SplitSink">SplitSink</a>&lt;S&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,&nbsp;</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&lt;S&gt; <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="../../../tokio/prelude/stream/struct.SplitSink.html" title="struct tokio::prelude::stream::SplitSink">SplitSink</a>&lt;S&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,&nbsp;</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>&#9166;</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>
</div>
</div>
</aside>
<script>
window.rootPath = "../../../";
window.currentCrate = "tokio";
</script>
<script src="../../../main.js"></script>
<script defer src="../../../search-index.js"></script>
</body>
</html>