<!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 `futures`.">
<meta name="keywords" content="rust, rustlang, rust-lang, SplitSink">
<title>futures::stream::SplitSink - Rust</title>
<link rel="stylesheet" type="text/css" href="../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../main.css">
</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">
<p class='location'><a href='../index.html'>futures</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>
</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">
<h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>futures</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'>−</span>]
</a>
</span><a class='srclink' href='../../src/futures/stream/split.rs.html#22' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct SplitSink<S>(_);</pre><div class='docblock'><p>A <code>Sink</code> part of the split pair</p>
</div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>impl<S: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>> <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="../../futures/stream/struct.SplitSink.html" title="struct futures::stream::SplitSink">SplitSink</a><S></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/futures/stream/split.rs.html#21' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, __arg_0: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></h4>
<div class='docblock'><p>Formats the value using the given formatter.</p>
</div></div><h3 class='impl'><span class='in-band'><code>impl<S: <a class="trait" href="../../futures/sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a>> <a class="trait" href="../../futures/sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a> for <a class="struct" href="../../futures/stream/struct.SplitSink.html" title="struct futures::stream::SplitSink">SplitSink</a><S></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/futures/stream/split.rs.html#24-50' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='associatedtype.SinkItem' class="type"><span id='SinkItem.t' class='invisible'><code>type <a href='../../futures/sink/trait.Sink.html#associatedtype.SinkItem' class="type">SinkItem</a> = S::<a class="trait" href="../../futures/sink/trait.Sink.html" title="trait futures::sink::Sink">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='../../futures/sink/trait.Sink.html#associatedtype.SinkError' class="type">SinkError</a> = S::<a class="trait" href="../../futures/sink/trait.Sink.html" title="trait futures::sink::Sink">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'><code>fn <a href='../../futures/sink/trait.Sink.html#tymethod.start_send' class='fnname'>start_send</a>(<br> &mut self, <br> item: S::<a class="trait" href="../../futures/sink/trait.Sink.html" title="trait futures::sink::Sink">SinkItem</a><br>) -> <a class="type" href="../../futures/type.StartSend.html" title="type futures::StartSend">StartSend</a><S::<a class="trait" href="../../futures/sink/trait.Sink.html" title="trait futures::sink::Sink">SinkItem</a>, S::<a class="trait" href="../../futures/sink/trait.Sink.html" title="trait futures::sink::Sink">SinkError</a>></code></span></h4>
<div class='docblock'><p>Begin the process of sending a value to the sink. <a href="../../futures/sink/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'><code>fn <a href='../../futures/sink/trait.Sink.html#tymethod.poll_complete' class='fnname'>poll_complete</a>(&mut self) -> <a class="type" href="../../futures/type.Poll.html" title="type futures::Poll">Poll</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>, S::<a class="trait" href="../../futures/sink/trait.Sink.html" title="trait futures::sink::Sink">SinkError</a>></code></span></h4>
<div class='docblock'><p>Flush all output from this sink, if necessary. <a href="../../futures/sink/trait.Sink.html#tymethod.poll_complete">Read more</a></p>
</div><h4 id='method.close' class="method"><span id='close.v' class='invisible'><code>fn <a href='../../futures/sink/trait.Sink.html#method.close' class='fnname'>close</a>(&mut self) -> <a class="type" href="../../futures/type.Poll.html" title="type futures::Poll">Poll</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>, S::<a class="trait" href="../../futures/sink/trait.Sink.html" title="trait futures::sink::Sink">SinkError</a>></code></span></h4>
<div class='docblock'><p>A method to indicate that no more values will ever be pushed into this sink. <a href="../../futures/sink/trait.Sink.html#method.close">Read more</a></p>
</div><h4 id='method.wait' class="method"><span id='wait.v' class='invisible'><code>fn <a href='../../futures/sink/trait.Sink.html#method.wait' class='fnname'>wait</a>(self) -> <a class="struct" href="../../futures/sink/struct.Wait.html" title="struct futures::sink::Wait">Wait</a><Self> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></span></h4>
<div class='docblock'><p>Creates a new object which will produce a synchronous sink. <a href="../../futures/sink/trait.Sink.html#method.wait">Read more</a></p>
</div><h4 id='method.with' class="method"><span id='with.v' class='invisible'><code>fn <a href='../../futures/sink/trait.Sink.html#method.with' class='fnname'>with</a><U, F, Fut>(self, f: F) -> <a class="struct" href="../../futures/sink/struct.With.html" title="struct futures::sink::With">With</a><Self, U, F, Fut> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/trait.FnMut.html" title="trait core::ops::FnMut">FnMut</a>(U) -> Fut,<br> Fut: <a class="trait" href="../../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Item = Self::<a class="trait" href="../../futures/sink/trait.Sink.html" title="trait futures::sink::Sink">SinkItem</a>>,<br> Fut::<a class="trait" href="../../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">Error</a>: <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="trait" href="../../futures/sink/trait.Sink.html" title="trait futures::sink::Sink">SinkError</a>>,<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></span></h4>
<div class='docblock'><p>Composes a function in front of the sink. <a href="../../futures/sink/trait.Sink.html#method.with">Read more</a></p>
</div><h4 id='method.sink_map_err' class="method"><span id='sink_map_err.v' class='invisible'><code>fn <a href='../../futures/sink/trait.Sink.html#method.sink_map_err' class='fnname'>sink_map_err</a><F, E>(self, f: F) -> <a class="struct" href="../../futures/sink/struct.SinkMapErr.html" title="struct futures::sink::SinkMapErr">SinkMapErr</a><Self, F> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/trait.FnOnce.html" title="trait core::ops::FnOnce">FnOnce</a>(Self::<a class="trait" href="../../futures/sink/trait.Sink.html" title="trait futures::sink::Sink">SinkError</a>) -> E,<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></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'><code>fn <a href='../../futures/sink/trait.Sink.html#method.sink_from_err' class='fnname'>sink_from_err</a><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="trait" href="../../futures/sink/trait.Sink.html" title="trait futures::sink::Sink">SinkError</a>>>(self) -> <a class="struct" href="../../futures/sink/struct.SinkFromErr.html" title="struct futures::sink::SinkFromErr">SinkFromErr</a><Self, E> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></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="../../futures/sink/trait.Sink.html#method.sink_from_err">Read more</a></p>
</div><h4 id='method.buffer' class="method"><span id='buffer.v' class='invisible'><code>fn <a href='../../futures/sink/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>) -> <a class="struct" href="../../futures/sink/struct.Buffer.html" title="struct futures::sink::Buffer">Buffer</a><Self> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></span></h4>
<div class='docblock'><p>Adds a fixed-size buffer to the current sink. <a href="../../futures/sink/trait.Sink.html#method.buffer">Read more</a></p>
</div><h4 id='method.flush' class="method"><span id='flush.v' class='invisible'><code>fn <a href='../../futures/sink/trait.Sink.html#method.flush' class='fnname'>flush</a>(self) -> <a class="struct" href="../../futures/sink/struct.Flush.html" title="struct futures::sink::Flush">Flush</a><Self> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></span></h4>
<div class='docblock'><p>A future that completes when the sink has finished processing all pending requests. <a href="../../futures/sink/trait.Sink.html#method.flush">Read more</a></p>
</div><h4 id='method.send' class="method"><span id='send.v' class='invisible'><code>fn <a href='../../futures/sink/trait.Sink.html#method.send' class='fnname'>send</a>(self, item: Self::<a class="trait" href="../../futures/sink/trait.Sink.html" title="trait futures::sink::Sink">SinkItem</a>) -> <a class="struct" href="../../futures/sink/struct.Send.html" title="struct futures::sink::Send">Send</a><Self> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></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="../../futures/sink/trait.Sink.html#method.send">Read more</a></p>
</div><h4 id='method.send_all' class="method"><span id='send_all.v' class='invisible'><code>fn <a href='../../futures/sink/trait.Sink.html#method.send_all' class='fnname'>send_all</a><S>(self, stream: S) -> <a class="struct" href="../../futures/sink/struct.SendAll.html" title="struct futures::sink::SendAll">SendAll</a><Self, S> <span class="where fmt-newline">where<br> S: <a class="trait" href="../../futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a><Item = Self::<a class="trait" href="../../futures/sink/trait.Sink.html" title="trait futures::sink::Sink">SinkItem</a>>,<br> Self::<a class="trait" href="../../futures/sink/trait.Sink.html" title="trait futures::sink::Sink">SinkError</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><S::<a class="trait" href="../../futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Error</a>>,<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></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="../../futures/sink/trait.Sink.html#method.send_all">Read more</a></p>
</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>?</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 = "futures";
</script>
<script src="../../jquery.js"></script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>