mentat/futures/sink/index.html
2018-08-22 17:04:13 +00:00

238 lines
No EOL
11 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

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

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="rustdoc">
<meta name="description" content="API documentation for the Rust `sink` mod in crate `futures`.">
<meta name="keywords" content="rust, rustlang, rust-lang, sink">
<title>futures::sink - 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 mod">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<div class="sidebar-menu">&#9776;</div>
<p class='location'>Module sink</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'><a href='../index.html'>futures</a></p><script>window.sidebarCurrent = {name: 'sink', ty: 'mod', 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'>Module <a href='../index.html'>futures</a>::<wbr><a class="mod" href=''>sink</a></span><span class='out-of-band'><span id='render-detail'>
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../../src/futures/sink/mod.rs.html#1-489' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>Asynchronous sinks</p>
<p>This module contains the <code>Sink</code> trait, along with a number of adapter types
for it. An overview is available in the documentation for the trait itself.</p>
<p>You can find more information/tutorials about streams <a href="https://tokio.rs/docs/getting-started/streams-and-sinks/">online at
https://tokio.rs</a></p>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class="struct" href="struct.Buffer.html"
title='struct futures::sink::Buffer'>Buffer</a></td>
<td class='docblock-short'>
<p>Sink for the <code>Sink::buffer</code> combinator, which buffers up to some fixed
number of values when the underlying sink is unable to accept them.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Fanout.html"
title='struct futures::sink::Fanout'>Fanout</a></td>
<td class='docblock-short'>
<p>Sink that clones incoming items and forwards them to two sinks at the same time.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Flush.html"
title='struct futures::sink::Flush'>Flush</a></td>
<td class='docblock-short'>
<p>Future for the <code>Sink::flush</code> combinator, which polls the sink until all data
has been flushed.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Send.html"
title='struct futures::sink::Send'>Send</a></td>
<td class='docblock-short'>
<p>Future for the <code>Sink::send</code> combinator, which sends a value to a sink and
then waits until the sink has fully flushed.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.SendAll.html"
title='struct futures::sink::SendAll'>SendAll</a></td>
<td class='docblock-short'>
<p>Future for the <code>Sink::send_all</code> combinator, which sends a stream of values
to a sink and then waits until the sink has fully flushed those values.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.SinkFromErr.html"
title='struct futures::sink::SinkFromErr'>SinkFromErr</a></td>
<td class='docblock-short'>
<p>A sink combinator to change the error type of a sink.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.SinkMapErr.html"
title='struct futures::sink::SinkMapErr'>SinkMapErr</a></td>
<td class='docblock-short'>
<p>Sink for the <code>Sink::sink_map_err</code> combinator.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Wait.html"
title='struct futures::sink::Wait'>Wait</a></td>
<td class='docblock-short'>
<p>A sink combinator which converts an asynchronous sink to a <strong>blocking
sink</strong>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.With.html"
title='struct futures::sink::With'>With</a></td>
<td class='docblock-short'>
<p>Sink for the <code>Sink::with</code> combinator, chaining a computation to run <em>prior</em>
to pushing a value into the underlying sink.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.WithFlatMap.html"
title='struct futures::sink::WithFlatMap'>WithFlatMap</a></td>
<td class='docblock-short'>
<p>Sink for the <code>Sink::with_flat_map</code> combinator, chaining a computation that returns an iterator
to run prior to pushing a value into the underlying sink</p>
</td>
</tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
<table>
<tr class=' module-item'>
<td><a class="trait" href="trait.Sink.html"
title='trait futures::sink::Sink'>Sink</a></td>
<td class='docblock-short'>
<p>A <code>Sink</code> is a value into which other values can be sent, asynchronously.</p>
</td>
</tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
<table>
<tr class=' module-item'>
<td><a class="type" href="type.BoxSink.html"
title='type futures::sink::BoxSink'>BoxSink</a></td>
<td class='docblock-short'>
<p>A type alias for <code>Box&lt;Sink + Send&gt;</code></p>
</td>
</tr></table></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt><kbd>?</kbd></dt>
<dd>Show this help dialog</dd>
<dt><kbd>S</kbd></dt>
<dd>Focus the search field</dd>
<dt><kbd></kbd></dt>
<dd>Move up in search results</dd>
<dt><kbd></kbd></dt>
<dd>Move down in search results</dd>
<dt><kbd></kbd></dt>
<dd>Switch tab</dd>
<dt><kbd>&#9166;</kbd></dt>
<dd>Go to active search result</dd>
<dt><kbd>+</kbd></dt>
<dd>Expand all sections</dd>
<dt><kbd>-</kbd></dt>
<dd>Collapse all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../../";
window.currentCrate = "futures";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>