274 lines
No EOL
92 KiB
HTML
274 lines
No EOL
92 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 `FramedWrite` struct in crate `tokio_codec`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, FramedWrite">
|
||
|
||
<title>tokio_codec::FramedWrite - 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="../main.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 FramedWrite</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><a href="#method.get_ref">get_ref</a><a href="#method.get_mut">get_mut</a><a href="#method.into_inner">into_inner</a><a href="#method.encoder">encoder</a><a href="#method.encoder_mut">encoder_mut</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Sink">Sink</a><a href="#impl-Stream">Stream</a></div></div><p class='location'><a href='index.html'>tokio_codec</a></p><script>window.sidebarCurrent = {name: 'FramedWrite', 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_codec</a>::<wbr><a class="struct" href=''>FramedWrite</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/tokio_io/_tokio_codec/framed_write.rs.html#14-16' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust struct'>pub struct FramedWrite<T, E> { /* fields omitted */ }</pre><div class='docblock'><p>A <code>Sink</code> of frames encoded to an <code>AsyncWrite</code>.</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'><code>impl<T, E> <a class="struct" href="../tokio_codec/struct.FramedWrite.html" title="struct tokio_codec::FramedWrite">FramedWrite</a><T, E> <span class="where fmt-newline">where<br> E: <a class="trait" href="../tokio_codec/trait.Encoder.html" title="trait tokio_codec::Encoder">Encoder</a>,<br> T: <a class="trait" href="../tokio_io/async_write/trait.AsyncWrite.html" title="trait tokio_io::async_write::AsyncWrite">AsyncWrite</a>, </span></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_io/_tokio_codec/framed_write.rs.html#26-36' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>pub fn <a href='#method.new' class='fnname'>new</a>(inner: T, encoder: E) -> <a class="struct" href="../tokio_codec/struct.FramedWrite.html" title="struct tokio_codec::FramedWrite">FramedWrite</a><T, E></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_io/_tokio_codec/framed_write.rs.html#31-35' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates a new <code>FramedWrite</code> with the given <code>encoder</code>.</p>
|
||
</div></div><h3 id='impl-1' class='impl'><span class='in-band'><code>impl<T, E> <a class="struct" href="../tokio_codec/struct.FramedWrite.html" title="struct tokio_codec::FramedWrite">FramedWrite</a><T, E></code><a href='#impl-1' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_io/_tokio_codec/framed_write.rs.html#38-77' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.get_ref' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R</h3><code class="content"><span class="where fmt-newline">impl<'a, R> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R <span class="where fmt-newline">where<br> R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, W> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>W <span class="where fmt-newline">where<br> W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, I> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>I <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <I as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item" title="type core::iter::iterator::Iterator::Item">Item</a>;</span></code></div></div><span id='get_ref.v' class='invisible'><code>pub fn <a href='#method.get_ref' class='fnname'>get_ref</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_io/_tokio_codec/framed_write.rs.html#45-47' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Returns a reference to the underlying I/O stream wrapped by
|
||
<code>FramedWrite</code>.</p>
|
||
<p>Note that care should be taken to not tamper with the underlying stream
|
||
of data coming in as it may corrupt the stream of frames otherwise
|
||
being worked with.</p>
|
||
</div><h4 id='method.get_mut' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R</h3><code class="content"><span class="where fmt-newline">impl<'a, R> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R <span class="where fmt-newline">where<br> R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, W> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>W <span class="where fmt-newline">where<br> W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, I> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>I <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <I as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item" title="type core::iter::iterator::Iterator::Item">Item</a>;</span></code></div></div><span id='get_mut.v' class='invisible'><code>pub fn <a href='#method.get_mut' class='fnname'>get_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_io/_tokio_codec/framed_write.rs.html#55-57' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Returns a mutable reference to the underlying I/O stream wrapped by
|
||
<code>FramedWrite</code>.</p>
|
||
<p>Note that care should be taken to not tamper with the underlying stream
|
||
of data coming in as it may corrupt the stream of frames otherwise
|
||
being worked with.</p>
|
||
</div><h4 id='method.into_inner' class="method"><span id='into_inner.v' class='invisible'><code>pub fn <a href='#method.into_inner' class='fnname'>into_inner</a>(self) -> T</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_io/_tokio_codec/framed_write.rs.html#64-66' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Consumes the <code>FramedWrite</code>, returning its underlying I/O stream.</p>
|
||
<p>Note that care should be taken to not tamper with the underlying stream
|
||
of data coming in as it may corrupt the stream of frames otherwise
|
||
being worked with.</p>
|
||
</div><h4 id='method.encoder' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R</h3><code class="content"><span class="where fmt-newline">impl<'a, R> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R <span class="where fmt-newline">where<br> R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, W> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>W <span class="where fmt-newline">where<br> W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, I> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>I <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <I as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item" title="type core::iter::iterator::Iterator::Item">Item</a>;</span></code></div></div><span id='encoder.v' class='invisible'><code>pub fn <a href='#method.encoder' class='fnname'>encoder</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>E</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_io/_tokio_codec/framed_write.rs.html#69-71' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Returns a reference to the underlying decoder.</p>
|
||
</div><h4 id='method.encoder_mut' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R</h3><code class="content"><span class="where fmt-newline">impl<'a, R> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R <span class="where fmt-newline">where<br> R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, W> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>W <span class="where fmt-newline">where<br> W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, I> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>I <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <I as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item" title="type core::iter::iterator::Iterator::Item">Item</a>;</span></code></div></div><span id='encoder_mut.v' class='invisible'><code>pub fn <a href='#method.encoder_mut' class='fnname'>encoder_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>E</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_io/_tokio_codec/framed_write.rs.html#74-76' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Returns a mutable reference to the underlying decoder.</p>
|
||
</div></div>
|
||
<h2 id='implementations' class='small-section-header'>
|
||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||
</h2>
|
||
<h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl<T, U> <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_codec/struct.FramedWrite.html" title="struct tokio_codec::FramedWrite">FramedWrite</a><T, U> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>,<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>, </span></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_io/_tokio_codec/framed_write.rs.html#110-121' 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, f: &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="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<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>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_io/_tokio_codec/framed_write.rs.html#114-120' title='goto source code'>[src]</a></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><h3 id='impl-Sink' class='impl'><span class='in-band'><code>impl<T, E> <a class="trait" href="../futures/sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a> for <a class="struct" href="../tokio_codec/struct.FramedWrite.html" title="struct tokio_codec::FramedWrite">FramedWrite</a><T, E> <span class="where fmt-newline">where<br> E: <a class="trait" href="../tokio_codec/trait.Encoder.html" title="trait tokio_codec::Encoder">Encoder</a>,<br> T: <a class="trait" href="../tokio_io/async_write/trait.AsyncWrite.html" title="trait tokio_io::async_write::AsyncWrite">AsyncWrite</a>, </span></code><a href='#impl-Sink' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_io/_tokio_codec/framed_write.rs.html#79-97' 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> = <E as <a class="trait" href="../tokio_codec/trait.Encoder.html" title="trait tokio_codec::Encoder">Encoder</a>>::<a class="type" href="../tokio_codec/trait.Encoder.html#associatedtype.Item" title="type tokio_codec::Encoder::Item">Item</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> = <E as <a class="trait" href="../tokio_codec/trait.Encoder.html" title="trait tokio_codec::Encoder">Encoder</a>>::<a class="type" href="../tokio_codec/trait.Encoder.html#associatedtype.Error" title="type tokio_codec::Encoder::Error">Error</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: <E as <a class="trait" href="../tokio_codec/trait.Encoder.html" title="trait tokio_codec::Encoder">Encoder</a>>::<a class="type" href="../tokio_codec/trait.Encoder.html#associatedtype.Item" title="type tokio_codec::Encoder::Item">Item</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="../futures/poll/enum.AsyncSink.html" title="enum futures::poll::AsyncSink">AsyncSink</a><<E as <a class="trait" href="../tokio_codec/trait.Encoder.html" title="trait tokio_codec::Encoder">Encoder</a>>::<a class="type" href="../tokio_codec/trait.Encoder.html#associatedtype.Item" title="type tokio_codec::Encoder::Item">Item</a>>, <E as <a class="trait" href="../tokio_codec/trait.Encoder.html" title="trait tokio_codec::Encoder">Encoder</a>>::<a class="type" href="../tokio_codec/trait.Encoder.html#associatedtype.Error" title="type tokio_codec::Encoder::Error">Error</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_io/_tokio_codec/framed_write.rs.html#86-88' title='goto source code'>[src]</a></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>(<br> &mut self<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="../futures/poll/enum.Async.html" title="enum futures::poll::Async">Async</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>, <<a class="struct" href="../tokio_codec/struct.FramedWrite.html" title="struct tokio_codec::FramedWrite">FramedWrite</a><T, E> as <a class="trait" href="../futures/sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a>>::<a class="type" href="../futures/sink/trait.Sink.html#associatedtype.SinkError" title="type futures::sink::Sink::SinkError">SinkError</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_io/_tokio_codec/framed_write.rs.html#90-92' title='goto source code'>[src]</a></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="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="../futures/poll/enum.Async.html" title="enum futures::poll::Async">Async</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>, <<a class="struct" href="../tokio_codec/struct.FramedWrite.html" title="struct tokio_codec::FramedWrite">FramedWrite</a><T, E> as <a class="trait" href="../futures/sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a>>::<a class="type" href="../futures/sink/trait.Sink.html#associatedtype.SinkError" title="type futures::sink::Sink::SinkError">SinkError</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_io/_tokio_codec/framed_write.rs.html#94-96' title='goto source code'>[src]</a></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/wait/struct.Wait.html" title="struct futures::sink::wait::Wait">Wait</a><Self></code></span><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></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/with/struct.With.html" title="struct futures::sink::with::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/function/trait.FnMut.html" title="trait core::ops::function::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="type" href="../futures/sink/trait.Sink.html#associatedtype.SinkItem" title="type futures::sink::Sink::SinkItem">SinkItem</a>>,<br> <Fut as <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>>::<a class="type" href="../futures/future/trait.IntoFuture.html#associatedtype.Error" title="type futures::future::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><Self::<a class="type" href="../futures/sink/trait.Sink.html#associatedtype.SinkError" title="type futures::sink::Sink::SinkError">SinkError</a>>, </span></code></span><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></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.with_flat_map' class="method"><span id='with_flat_map.v' class='invisible'><code>fn <a href='../futures/sink/trait.Sink.html#method.with_flat_map' class='fnname'>with_flat_map</a><U, F, St>(self, f: F) -> <a class="struct" href="../futures/sink/with_flat_map/struct.WithFlatMap.html" title="struct futures::sink::with_flat_map::WithFlatMap">WithFlatMap</a><Self, U, F, St> <span class="where fmt-newline">where<br> 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) -> St,<br> St: <a class="trait" href="../futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a><Item = Self::<a class="type" href="../futures/sink/trait.Sink.html#associatedtype.SinkItem" title="type futures::sink::Sink::SinkItem">SinkItem</a>, Error = Self::<a class="type" href="../futures/sink/trait.Sink.html#associatedtype.SinkError" title="type futures::sink::Sink::SinkError">SinkError</a>>, </span></code></span><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></span></h4>
|
||
<div class='docblock'><p>Composes a function in front of the sink. <a href="../futures/sink/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'><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/map_err/struct.SinkMapErr.html" title="struct futures::sink::map_err::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/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(Self::<a class="type" href="../futures/sink/trait.Sink.html#associatedtype.SinkError" title="type futures::sink::Sink::SinkError">SinkError</a>) -> E, </span></code></span><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></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>(self) -> <a class="struct" href="../futures/sink/from_err/struct.SinkFromErr.html" title="struct futures::sink::from_err::SinkFromErr">SinkFromErr</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="../futures/sink/trait.Sink.html#associatedtype.SinkError" title="type futures::sink::Sink::SinkError">SinkError</a>>, </span></code></span><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></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/buffer/struct.Buffer.html" title="struct futures::sink::buffer::Buffer">Buffer</a><Self></code></span><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></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.fanout' class="method"><span id='fanout.v' class='invisible'><code>fn <a href='../futures/sink/trait.Sink.html#method.fanout' class='fnname'>fanout</a><S>(self, other: S) -> <a class="struct" href="../futures/sink/fanout/struct.Fanout.html" title="struct futures::sink::fanout::Fanout">Fanout</a><Self, S> <span class="where fmt-newline">where<br> S: <a class="trait" href="../futures/sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a><SinkItem = Self::<a class="type" href="../futures/sink/trait.Sink.html#associatedtype.SinkItem" title="type futures::sink::Sink::SinkItem">SinkItem</a>, SinkError = Self::<a class="type" href="../futures/sink/trait.Sink.html#associatedtype.SinkError" title="type futures::sink::Sink::SinkError">SinkError</a>>,<br> Self::<a class="type" href="../futures/sink/trait.Sink.html#associatedtype.SinkItem" title="type futures::sink::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>, </span></code></span><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></span></h4>
|
||
<div class='docblock'><p>Fanout items to multiple sinks. <a href="../futures/sink/trait.Sink.html#method.fanout">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/flush/struct.Flush.html" title="struct futures::sink::flush::Flush">Flush</a><Self></code></span><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></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="type" href="../futures/sink/trait.Sink.html#associatedtype.SinkItem" title="type futures::sink::Sink::SinkItem">SinkItem</a>) -> <a class="struct" href="../futures/sink/send/struct.Send.html" title="struct futures::sink::send::Send">Send</a><Self></code></span><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></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/send_all/struct.SendAll.html" title="struct futures::sink::send_all::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="type" href="../futures/sink/trait.Sink.html#associatedtype.SinkItem" title="type futures::sink::Sink::SinkItem">SinkItem</a>>,<br> Self::<a class="type" href="../futures/sink/trait.Sink.html#associatedtype.SinkError" title="type futures::sink::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><<S as <a class="trait" href="../futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a>>::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Error" title="type futures::stream::Stream::Error">Error</a>>, </span></code></span><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></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><h3 id='impl-Stream' class='impl'><span class='in-band'><code>impl<T, D> <a class="trait" href="../futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a> for <a class="struct" href="../tokio_codec/struct.FramedWrite.html" title="struct tokio_codec::FramedWrite">FramedWrite</a><T, D> <span class="where fmt-newline">where<br> T: <a class="trait" href="../futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a>, </span></code><a href='#impl-Stream' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_io/_tokio_codec/framed_write.rs.html#99-108' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='associatedtype.Item' class="type"><span id='Item.t' class='invisible'><code>type <a href='../futures/stream/trait.Stream.html#associatedtype.Item' class="type">Item</a> = <T as <a class="trait" href="../futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a>>::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a></code></span></h4>
|
||
<div class='docblock'><p>The type of item this stream will yield on success.</p>
|
||
</div><h4 id='associatedtype.Error' class="type"><span id='Error.t' class='invisible'><code>type <a href='../futures/stream/trait.Stream.html#associatedtype.Error' class="type">Error</a> = <T as <a class="trait" href="../futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a>>::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Error" title="type futures::stream::Stream::Error">Error</a></code></span></h4>
|
||
<div class='docblock'><p>The type of error this stream may generate.</p>
|
||
</div><h4 id='method.poll' class="method"><span id='poll.v' class='invisible'><code>fn <a href='../futures/stream/trait.Stream.html#tymethod.poll' class='fnname'>poll</a>(<br> &mut self<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="../futures/poll/enum.Async.html" title="enum futures::poll::Async">Async</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<<a class="struct" href="../tokio_codec/struct.FramedWrite.html" title="struct tokio_codec::FramedWrite">FramedWrite</a><T, D> as <a class="trait" href="../futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a>>::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a>>>, <<a class="struct" href="../tokio_codec/struct.FramedWrite.html" title="struct tokio_codec::FramedWrite">FramedWrite</a><T, D> as <a class="trait" href="../futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a>>::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Error" title="type futures::stream::Stream::Error">Error</a>></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/tokio_io/_tokio_codec/framed_write.rs.html#105-107' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Attempt to pull out the next value of this stream, returning <code>None</code> if the stream is finished. <a href="../futures/stream/trait.Stream.html#tymethod.poll">Read more</a></p>
|
||
</div><h4 id='method.wait-1' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../futures/stream/wait/struct.Wait.html" title="struct futures::stream::wait::Wait">Wait</a><S></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../futures/stream/wait/struct.Wait.html" title="struct futures::stream::wait::Wait">Wait</a><S></h3><code class="content"><span class="where fmt-newline">impl<S> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="../futures/stream/wait/struct.Wait.html" title="struct futures::stream::wait::Wait">Wait</a><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>, </span></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<S as <a class="trait" href="../futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a>>::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a>, <S as <a class="trait" href="../futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a>>::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Error" title="type futures::stream::Stream::Error">Error</a>>;</span></code></div></div><span id='wait.v-1' class='invisible'><code>fn <a href='../futures/stream/trait.Stream.html#method.wait' class='fnname'>wait</a>(self) -> <a class="struct" href="../futures/stream/wait/struct.Wait.html" title="struct futures::stream::wait::Wait">Wait</a><Self></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/stream/mod.rs.html#244-248' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates an iterator which blocks the current thread until each item of this stream is resolved. <a href="../futures/stream/trait.Stream.html#method.wait">Read more</a></p>
|
||
</div><h4 id='method.into_future' class="method"><span id='into_future.v' class='invisible'><code>fn <a href='../futures/stream/trait.Stream.html#method.into_future' class='fnname'>into_future</a>(self) -> <a class="struct" href="../futures/stream/future/struct.StreamFuture.html" title="struct futures::stream::future::StreamFuture">StreamFuture</a><Self></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/stream/mod.rs.html#291-295' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Converts this stream into a <code>Future</code>. <a href="../futures/stream/trait.Stream.html#method.into_future">Read more</a></p>
|
||
</div><h4 id='method.map' class="method"><span id='map.v' class='invisible'><code>fn <a href='../futures/stream/trait.Stream.html#method.map' class='fnname'>map</a><U, F>(self, f: F) -> <a class="struct" href="../futures/stream/map/struct.Map.html" title="struct futures::stream::map::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.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a>) -> U, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/stream/mod.rs.html#316-321' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Converts a stream of type <code>T</code> to a stream of type <code>U</code>. <a href="../futures/stream/trait.Stream.html#method.map">Read more</a></p>
|
||
</div><h4 id='method.map_err' class="method"><span id='map_err.v' class='invisible'><code>fn <a href='../futures/stream/trait.Stream.html#method.map_err' class='fnname'>map_err</a><U, F>(self, f: F) -> <a class="struct" href="../futures/stream/map_err/struct.MapErr.html" title="struct futures::stream::map_err::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.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Error" title="type futures::stream::Stream::Error">Error</a>) -> U, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/stream/mod.rs.html#342-347' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Converts a stream of error type <code>T</code> to a stream of error type <code>U</code>. <a href="../futures/stream/trait.Stream.html#method.map_err">Read more</a></p>
|
||
</div><h4 id='method.filter' class="method"><span id='filter.v' class='invisible'><code>fn <a href='../futures/stream/trait.Stream.html#method.filter' class='fnname'>filter</a><F>(self, f: F) -> <a class="struct" href="../futures/stream/filter/struct.Filter.html" title="struct futures::stream::filter::Filter">Filter</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.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/stream/mod.rs.html#372-377' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Filters the values produced by this stream according to the provided predicate. <a href="../futures/stream/trait.Stream.html#method.filter">Read more</a></p>
|
||
</div><h4 id='method.filter_map' class="method"><span id='filter_map.v' class='invisible'><code>fn <a href='../futures/stream/trait.Stream.html#method.filter_map' class='fnname'>filter_map</a><F, B>(self, f: F) -> <a class="struct" href="../futures/stream/filter_map/struct.FilterMap.html" title="struct futures::stream::filter_map::FilterMap">FilterMap</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.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><B>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/stream/mod.rs.html#408-413' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Filters the values produced by this stream while simultaneously mapping them to a different type. <a href="../futures/stream/trait.Stream.html#method.filter_map">Read more</a></p>
|
||
</div><h4 id='method.then' class="method"><span id='then.v' class='invisible'><code>fn <a href='../futures/stream/trait.Stream.html#method.then' class='fnname'>then</a><F, U>(self, f: F) -> <a class="struct" href="../futures/stream/then/struct.Then.html" title="struct futures::stream::then::Then">Then</a><Self, F, U> <span class="where fmt-newline">where<br> 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>(<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="../futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a>, Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Error" title="type futures::stream::Stream::Error">Error</a>>) -> U,<br> U: <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/stream/mod.rs.html#447-453' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Chain on a computation for when a value is ready, passing the resulting item to the provided closure <code>f</code>. <a href="../futures/stream/trait.Stream.html#method.then">Read more</a></p>
|
||
</div><h4 id='method.and_then' class="method"><span id='and_then.v' class='invisible'><code>fn <a href='../futures/stream/trait.Stream.html#method.and_then' class='fnname'>and_then</a><F, U>(self, f: F) -> <a class="struct" href="../futures/stream/and_then/struct.AndThen.html" title="struct futures::stream::and_then::AndThen">AndThen</a><Self, F, U> <span class="where fmt-newline">where<br> 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>(Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a>) -> U,<br> U: <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Error = Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Error" title="type futures::stream::Stream::Error">Error</a>>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/stream/mod.rs.html#494-500' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Chain on a computation for when a value is ready, passing the successful results to the provided closure <code>f</code>. <a href="../futures/stream/trait.Stream.html#method.and_then">Read more</a></p>
|
||
</div><h4 id='method.or_else' class="method"><span id='or_else.v' class='invisible'><code>fn <a href='../futures/stream/trait.Stream.html#method.or_else' class='fnname'>or_else</a><F, U>(self, f: F) -> <a class="struct" href="../futures/stream/or_else/struct.OrElse.html" title="struct futures::stream::or_else::OrElse">OrElse</a><Self, F, U> <span class="where fmt-newline">where<br> 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>(Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Error" title="type futures::stream::Stream::Error">Error</a>) -> U,<br> U: <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Item = Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a>>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/stream/mod.rs.html#521-527' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Chain on a computation for when an error happens, passing the erroneous result to the provided closure <code>f</code>. <a href="../futures/stream/trait.Stream.html#method.or_else">Read more</a></p>
|
||
</div><h4 id='method.collect' class="method"><span id='collect.v' class='invisible'><code>fn <a href='../futures/stream/trait.Stream.html#method.collect' class='fnname'>collect</a>(self) -> <a class="struct" href="../futures/stream/collect/struct.Collect.html" title="struct futures::stream::collect::Collect">Collect</a><Self></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/stream/mod.rs.html#562-566' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Collect all of the values of this stream into a vector, returning a future representing the result of that computation. <a href="../futures/stream/trait.Stream.html#method.collect">Read more</a></p>
|
||
</div><h4 id='method.concat2' class="method"><span id='concat2.v' class='invisible'><code>fn <a href='../futures/stream/trait.Stream.html#method.concat2' class='fnname'>concat2</a>(self) -> <a class="struct" href="../futures/stream/concat/struct.Concat2.html" title="struct futures::stream::concat::Concat2">Concat2</a><Self> <span class="where fmt-newline">where<br> Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.Extend.html" title="trait core::iter::traits::Extend">Extend</a><<Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a> as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::IntoIterator::Item">Item</a>>,<br> Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a>,<br> Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/stream/mod.rs.html#598-603' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Concatenate all results of a stream into a single extendable destination, returning a future representing the end result. <a href="../futures/stream/trait.Stream.html#method.concat2">Read more</a></p>
|
||
</div><h4 id='method.concat' class="method"><span id='concat.v' class='invisible'><code>fn <a href='../futures/stream/trait.Stream.html#method.concat' class='fnname'>concat</a>(self) -> <a class="struct" href="../futures/stream/concat/struct.Concat.html" title="struct futures::stream::concat::Concat">Concat</a><Self> <span class="where fmt-newline">where<br> Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.Extend.html" title="trait core::iter::traits::Extend">Extend</a><<Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a> as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::IntoIterator::Item">Item</a>>,<br> Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/stream/mod.rs.html#638-643' title='goto source code'>[src]</a></span></h4>
|
||
<div class='stability'><div class='stab deprecated'>Deprecated since 0.1.14<p>: please use <code>Stream::concat2</code> instead</p>
|
||
</div></div><div class='docblock'><p>Concatenate all results of a stream into a single extendable destination, returning a future representing the end result. <a href="../futures/stream/trait.Stream.html#method.concat">Read more</a></p>
|
||
</div><h4 id='method.fold' class="method"><span id='fold.v' class='invisible'><code>fn <a href='../futures/stream/trait.Stream.html#method.fold' class='fnname'>fold</a><F, T, Fut>(self, init: T, f: F) -> <a class="struct" href="../futures/stream/fold/struct.Fold.html" title="struct futures::stream::fold::Fold">Fold</a><Self, F, Fut, T> <span class="where fmt-newline">where<br> 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>(T, Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a>) -> Fut,<br> Fut: <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Item = T>,<br> Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Error" title="type futures::stream::Stream::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><<Fut as <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>>::<a class="type" href="../futures/future/trait.IntoFuture.html#associatedtype.Error" title="type futures::future::IntoFuture::Error">Error</a>>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/stream/mod.rs.html#668-675' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Execute an accumulating computation over a stream, collecting all the values into one final result. <a href="../futures/stream/trait.Stream.html#method.fold">Read more</a></p>
|
||
</div><h4 id='method.flatten' class="method"><span id='flatten.v' class='invisible'><code>fn <a href='../futures/stream/trait.Stream.html#method.flatten' class='fnname'>flatten</a>(self) -> <a class="struct" href="../futures/stream/flatten/struct.Flatten.html" title="struct futures::stream::flatten::Flatten">Flatten</a><Self> <span class="where fmt-newline">where<br> Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a>: <a class="trait" href="../futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a>,<br> <Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a> as <a class="trait" href="../futures/stream/trait.Stream.html" title="trait futures::stream::Stream">Stream</a>>::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Error" title="type futures::stream::Stream::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><Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Error" title="type futures::stream::Stream::Error">Error</a>>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/stream/mod.rs.html#710-716' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Flattens a stream of streams into just one continuous stream. <a href="../futures/stream/trait.Stream.html#method.flatten">Read more</a></p>
|
||
</div><h4 id='method.skip_while' class="method"><span id='skip_while.v' class='invisible'><code>fn <a href='../futures/stream/trait.Stream.html#method.skip_while' class='fnname'>skip_while</a><P, R>(self, pred: P) -> <a class="struct" href="../futures/stream/skip_while/struct.SkipWhile.html" title="struct futures::stream::skip_while::SkipWhile">SkipWhile</a><Self, P, R> <span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a>) -> R,<br> R: <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, Error = Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Error" title="type futures::stream::Stream::Error">Error</a>>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/stream/mod.rs.html#725-731' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Skip elements on this stream while the predicate provided resolves to <code>true</code>. <a href="../futures/stream/trait.Stream.html#method.skip_while">Read more</a></p>
|
||
</div><h4 id='method.take_while' class="method"><span id='take_while.v' class='invisible'><code>fn <a href='../futures/stream/trait.Stream.html#method.take_while' class='fnname'>take_while</a><P, R>(self, pred: P) -> <a class="struct" href="../futures/stream/take_while/struct.TakeWhile.html" title="struct futures::stream::take_while::TakeWhile">TakeWhile</a><Self, P, R> <span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a>) -> R,<br> R: <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, Error = Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Error" title="type futures::stream::Stream::Error">Error</a>>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/stream/mod.rs.html#739-745' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Take elements from this stream while the predicate provided resolves to <code>true</code>. <a href="../futures/stream/trait.Stream.html#method.take_while">Read more</a></p>
|
||
</div><h4 id='method.for_each' class="method"><span id='for_each.v' class='invisible'><code>fn <a href='../futures/stream/trait.Stream.html#method.for_each' class='fnname'>for_each</a><F, U>(self, f: F) -> <a class="struct" href="../futures/stream/for_each/struct.ForEach.html" title="struct futures::stream::for_each::ForEach">ForEach</a><Self, F, U> <span class="where fmt-newline">where<br> 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>(Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a>) -> U,<br> U: <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a><Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Error = Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Error" title="type futures::stream::Stream::Error">Error</a>>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/stream/mod.rs.html#761-767' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Runs this stream to completion, executing the provided closure for each element on the stream. <a href="../futures/stream/trait.Stream.html#method.for_each">Read more</a></p>
|
||
</div><h4 id='method.from_err' class="method"><span id='from_err.v' class='invisible'><code>fn <a href='../futures/stream/trait.Stream.html#method.from_err' class='fnname'>from_err</a><E>(self) -> <a class="struct" href="../futures/stream/from_err/struct.FromErr.html" title="struct futures::stream::from_err::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="../futures/stream/trait.Stream.html#associatedtype.Error" title="type futures::stream::Stream::Error">Error</a>>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/stream/mod.rs.html#780-784' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Map this stream's error to any error implementing <code>From</code> for this stream's <code>Error</code>, returning a new stream. <a href="../futures/stream/trait.Stream.html#method.from_err">Read more</a></p>
|
||
</div><h4 id='method.take' class="method"><span id='take.v' class='invisible'><code>fn <a href='../futures/stream/trait.Stream.html#method.take' class='fnname'>take</a>(self, amt: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>) -> <a class="struct" href="../futures/stream/take/struct.Take.html" title="struct futures::stream::take::Take">Take</a><Self></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/stream/mod.rs.html#796-800' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates a new stream of at most <code>amt</code> items of the underlying stream. <a href="../futures/stream/trait.Stream.html#method.take">Read more</a></p>
|
||
</div><h4 id='method.skip' class="method"><span id='skip.v' class='invisible'><code>fn <a href='../futures/stream/trait.Stream.html#method.skip' class='fnname'>skip</a>(self, amt: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>) -> <a class="struct" href="../futures/stream/skip/struct.Skip.html" title="struct futures::stream::skip::Skip">Skip</a><Self></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/stream/mod.rs.html#811-815' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates a new stream which skips <code>amt</code> items of the underlying stream. <a href="../futures/stream/trait.Stream.html#method.skip">Read more</a></p>
|
||
</div><h4 id='method.fuse' class="method"><span id='fuse.v' class='invisible'><code>fn <a href='../futures/stream/trait.Stream.html#method.fuse' class='fnname'>fuse</a>(self) -> <a class="struct" href="../futures/stream/fuse/struct.Fuse.html" title="struct futures::stream::fuse::Fuse">Fuse</a><Self></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/stream/mod.rs.html#832-836' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Fuse a stream such that <code>poll</code> will never again be called once it has finished. <a href="../futures/stream/trait.Stream.html#method.fuse">Read more</a></p>
|
||
</div><h4 id='method.by_ref' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R</h3><code class="content"><span class="where fmt-newline">impl<'a, R> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>R <span class="where fmt-newline">where<br> R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, W> <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>W <span class="where fmt-newline">where<br> W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline">impl<'a, I> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>I <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <I as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item" title="type core::iter::iterator::Iterator::Item">Item</a>;</span></code></div></div><span id='by_ref.v' class='invisible'><code>fn <a href='../futures/stream/trait.Stream.html#method.by_ref' class='fnname'>by_ref</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/stream/mod.rs.html#857-861' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Borrows a stream, rather than consuming it. <a href="../futures/stream/trait.Stream.html#method.by_ref">Read more</a></p>
|
||
</div><h4 id='method.catch_unwind' class="method"><span id='catch_unwind.v' class='invisible'><code>fn <a href='../futures/stream/trait.Stream.html#method.catch_unwind' class='fnname'>catch_unwind</a>(self) -> <a class="struct" href="../futures/stream/catch_unwind/struct.CatchUnwind.html" title="struct futures::stream::catch_unwind::CatchUnwind">CatchUnwind</a><Self> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/stream/mod.rs.html#897-901' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Catches unwinding panics while polling the stream. <a href="../futures/stream/trait.Stream.html#method.catch_unwind">Read more</a></p>
|
||
</div><h4 id='method.buffered' class="method"><span id='buffered.v' class='invisible'><code>fn <a href='../futures/stream/trait.Stream.html#method.buffered' class='fnname'>buffered</a>(self, amt: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="../futures/stream/buffered/struct.Buffered.html" title="struct futures::stream::buffered::Buffered">Buffered</a><Self> <span class="where fmt-newline">where<br> Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a>: <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>,<br> <Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a> as <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>>::<a class="type" href="../futures/future/trait.IntoFuture.html#associatedtype.Error" title="type futures::future::IntoFuture::Error">Error</a> == Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Error" title="type futures::stream::Stream::Error">Error</a>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/stream/mod.rs.html#917-922' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>An adaptor for creating a buffered list of pending futures. <a href="../futures/stream/trait.Stream.html#method.buffered">Read more</a></p>
|
||
</div><h4 id='method.buffer_unordered' class="method"><span id='buffer_unordered.v' class='invisible'><code>fn <a href='../futures/stream/trait.Stream.html#method.buffer_unordered' class='fnname'>buffer_unordered</a>(self, amt: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="../futures/stream/buffer_unordered/struct.BufferUnordered.html" title="struct futures::stream::buffer_unordered::BufferUnordered">BufferUnordered</a><Self> <span class="where fmt-newline">where<br> Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a>: <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>,<br> <Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a> as <a class="trait" href="../futures/future/trait.IntoFuture.html" title="trait futures::future::IntoFuture">IntoFuture</a>>::<a class="type" href="../futures/future/trait.IntoFuture.html#associatedtype.Error" title="type futures::future::IntoFuture::Error">Error</a> == Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Error" title="type futures::stream::Stream::Error">Error</a>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/stream/mod.rs.html#938-943' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>An adaptor for creating a buffered list of pending futures (unordered). <a href="../futures/stream/trait.Stream.html#method.buffer_unordered">Read more</a></p>
|
||
</div><h4 id='method.merge' class="method"><span id='merge.v' class='invisible'><code>fn <a href='../futures/stream/trait.Stream.html#method.merge' class='fnname'>merge</a><S>(self, other: S) -> <a class="struct" href="../futures/stream/merge/struct.Merge.html" title="struct futures::stream::merge::Merge">Merge</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><Error = Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Error" title="type futures::stream::Stream::Error">Error</a>>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/stream/mod.rs.html#952-957' title='goto source code'>[src]</a></span></h4>
|
||
<div class='stability'><div class='stab deprecated'>Deprecated<p>: functionality provided by <code>select</code> now</p>
|
||
</div></div><div class='docblock'><p>An adapter for merging the output of two streams. <a href="../futures/stream/trait.Stream.html#method.merge">Read more</a></p>
|
||
</div><h4 id='method.zip' class="method"><span id='zip.v' class='invisible'><code>fn <a href='../futures/stream/trait.Stream.html#method.zip' class='fnname'>zip</a><S>(self, other: S) -> <a class="struct" href="../futures/stream/zip/struct.Zip.html" title="struct futures::stream::zip::Zip">Zip</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><Error = Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Error" title="type futures::stream::Stream::Error">Error</a>>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/stream/mod.rs.html#964-969' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>An adapter for zipping two streams together. <a href="../futures/stream/trait.Stream.html#method.zip">Read more</a></p>
|
||
</div><h4 id='method.chain' class="method"><span id='chain.v' class='invisible'><code>fn <a href='../futures/stream/trait.Stream.html#method.chain' class='fnname'>chain</a><S>(self, other: S) -> <a class="struct" href="../futures/stream/chain/struct.Chain.html" title="struct futures::stream::chain::Chain">Chain</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="type" href="../futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a>, Error = Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Error" title="type futures::stream::Stream::Error">Error</a>>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/stream/mod.rs.html#990-995' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Adapter for chaining two stream. <a href="../futures/stream/trait.Stream.html#method.chain">Read more</a></p>
|
||
</div><h4 id='method.peekable' class="method"><span id='peekable.v' class='invisible'><code>fn <a href='../futures/stream/trait.Stream.html#method.peekable' class='fnname'>peekable</a>(self) -> <a class="struct" href="../futures/stream/peek/struct.Peekable.html" title="struct futures::stream::peek::Peekable">Peekable</a><Self></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/stream/mod.rs.html#1000-1004' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates a new stream which exposes a <code>peek</code> method. <a href="../futures/stream/trait.Stream.html#method.peekable">Read more</a></p>
|
||
</div><h4 id='method.chunks' class="method"><span id='chunks.v' class='invisible'><code>fn <a href='../futures/stream/trait.Stream.html#method.chunks' class='fnname'>chunks</a>(self, capacity: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="../futures/stream/chunks/struct.Chunks.html" title="struct futures::stream::chunks::Chunks">Chunks</a><Self></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/stream/mod.rs.html#1027-1031' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>An adaptor for chunking up items of the stream inside a vector. <a href="../futures/stream/trait.Stream.html#method.chunks">Read more</a></p>
|
||
</div><h4 id='method.select' class="method"><span id='select.v' class='invisible'><code>fn <a href='../futures/stream/trait.Stream.html#method.select' class='fnname'>select</a><S>(self, other: S) -> <a class="struct" href="../futures/stream/select/struct.Select.html" title="struct futures::stream::select::Select">Select</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="type" href="../futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a>, Error = Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Error" title="type futures::stream::Stream::Error">Error</a>>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/stream/mod.rs.html#1044-1049' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates a stream that selects the next element from either this stream or the provided one, whichever is ready first. <a href="../futures/stream/trait.Stream.html#method.select">Read more</a></p>
|
||
</div><h4 id='method.forward' class="method"><span id='forward.v' class='invisible'><code>fn <a href='../futures/stream/trait.Stream.html#method.forward' class='fnname'>forward</a><S>(self, sink: S) -> <a class="struct" href="../futures/stream/forward/struct.Forward.html" title="struct futures::stream::forward::Forward">Forward</a><Self, S> <span class="where fmt-newline">where<br> S: <a class="trait" href="../futures/sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a><SinkItem = Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a>>,<br> Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Error" title="type futures::stream::Stream::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><<S as <a class="trait" href="../futures/sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a>>::<a class="type" href="../futures/sink/trait.Sink.html#associatedtype.SinkError" title="type futures::sink::Sink::SinkError">SinkError</a>>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/stream/mod.rs.html#1065-1071' title='goto source code'>[src]</a></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/stream/trait.Stream.html#method.forward">Read more</a></p>
|
||
</div><h4 id='method.split' class="method"><span id='split.v' class='invisible'><code>fn <a href='../futures/stream/trait.Stream.html#method.split' class='fnname'>split</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="../futures/stream/split/struct.SplitSink.html" title="struct futures::stream::split::SplitSink">SplitSink</a><Self>, <a class="struct" href="../futures/stream/split/struct.SplitStream.html" title="struct futures::stream::split::SplitStream">SplitStream</a><Self><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a> <span class="where fmt-newline">where<br> Self: <a class="trait" href="../futures/sink/trait.Sink.html" title="trait futures::sink::Sink">Sink</a>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/stream/mod.rs.html#1083-1087' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Splits this <code>Stream + Sink</code> object into separate <code>Stream</code> and <code>Sink</code> objects. <a href="../futures/stream/trait.Stream.html#method.split">Read more</a></p>
|
||
</div><h4 id='method.inspect' class="method"><span id='inspect.v' class='invisible'><code>fn <a href='../futures/stream/trait.Stream.html#method.inspect' class='fnname'>inspect</a><F>(self, f: F) -> <a class="struct" href="../futures/stream/inspect/struct.Inspect.html" title="struct futures::stream::inspect::Inspect">Inspect</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.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Item" title="type futures::stream::Stream::Item">Item</a>), </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/stream/mod.rs.html#1094-1099' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Do something with each item of this stream, afterwards passing it on. <a href="../futures/stream/trait.Stream.html#method.inspect">Read more</a></p>
|
||
</div><h4 id='method.inspect_err' class="method"><span id='inspect_err.v' class='invisible'><code>fn <a href='../futures/stream/trait.Stream.html#method.inspect_err' class='fnname'>inspect_err</a><F>(self, f: F) -> <a class="struct" href="../futures/stream/inspect_err/struct.InspectErr.html" title="struct futures::stream::inspect_err::InspectErr">InspectErr</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.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&Self::<a class="type" href="../futures/stream/trait.Stream.html#associatedtype.Error" title="type futures::stream::Stream::Error">Error</a>), </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/futures/stream/mod.rs.html#1106-1111' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Do something with the error of this stream, afterwards passing it on. <a href="../futures/stream/trait.Stream.html#method.inspect_err">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><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>
|
||
</div>
|
||
</div>
|
||
</aside>
|
||
|
||
|
||
|
||
<script>
|
||
window.rootPath = "../";
|
||
window.currentCrate = "tokio_codec";
|
||
</script>
|
||
<script src="../main.js"></script>
|
||
<script defer src="../search-index.js"></script>
|
||
</body>
|
||
</html> |