Files
google-apis-rs/futures/sink/index.html
2021-04-02 00:20:57 +08:00

33 lines
8.5 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="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></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><a href='../../futures/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><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="#functions">Functions</a></li></ul></div><p class="location"><a href="../index.html">futures</a></p><div id="sidebar-vars" data-name="sink" data-ty="mod" data-relpath="../"></div><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"></div><button type="button" class="help-button">?</button>
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></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_util/lib.rs.html#320" title="goto source code">[src]</a></span></h1><div class="docblock"><p>Asynchronous sinks.</p>
<p>This module contains:</p>
<ul>
<li>The <a href="../../futures/sink/trait.Sink.html" title="Sink"><code>Sink</code></a> trait, which allows you to asynchronously write data.</li>
<li>The <a href="../../futures/sink/trait.SinkExt.html" title="SinkExt"><code>SinkExt</code></a> trait, which provides adapters for chaining and composing
sinks.</li>
</ul>
</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="futures::sink::Buffer struct">Buffer</a></td><td class="docblock-short"><p>Sink for the <a href="../../futures/sink/trait.SinkExt.html#method.buffer"><code>buffer</code></a> method.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Close.html" title="futures::sink::Close struct">Close</a></td><td class="docblock-short"><p>Future for the <a href="../../futures/sink/trait.SinkExt.html#method.close"><code>close</code></a> method.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Drain.html" title="futures::sink::Drain struct">Drain</a></td><td class="docblock-short"><p>Sink for the <a href="../../futures/sink/fn.drain.html" title="drain"><code>drain</code></a> function.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Fanout.html" title="futures::sink::Fanout struct">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.Feed.html" title="futures::sink::Feed struct">Feed</a></td><td class="docblock-short"><p>Future for the <a href="../../futures/sink/trait.SinkExt.html#method.feed"><code>feed</code></a> method.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Flush.html" title="futures::sink::Flush struct">Flush</a></td><td class="docblock-short"><p>Future for the <a href="../../futures/sink/trait.SinkExt.html#method.flush"><code>flush</code></a> method.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Send.html" title="futures::sink::Send struct">Send</a></td><td class="docblock-short"><p>Future for the <a href="../../futures/sink/trait.SinkExt.html#method.send"><code>send</code></a> method.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SendAll.html" title="futures::sink::SendAll struct">SendAll</a></td><td class="docblock-short"><p>Future for the <a href="../../futures/sink/trait.SinkExt.html#method.send_all"><code>send_all</code></a> method.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SinkErrInto.html" title="futures::sink::SinkErrInto struct">SinkErrInto</a></td><td class="docblock-short"><p>Sink for the <a href="../../futures/sink/trait.SinkExt.html#method.sink_err_into"><code>sink_err_into</code></a> method.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.SinkMapErr.html" title="futures::sink::SinkMapErr struct">SinkMapErr</a></td><td class="docblock-short"><p>Sink for the <a href="../../futures/sink/trait.SinkExt.html#method.sink_map_err"><code>sink_map_err</code></a> method.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Unfold.html" title="futures::sink::Unfold struct">Unfold</a></td><td class="docblock-short"><p>Sink for the <a href="../../futures/sink/fn.unfold.html" title="unfold"><code>unfold</code></a> function.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.With.html" title="futures::sink::With struct">With</a></td><td class="docblock-short"><p>Sink for the <a href="../../futures/sink/trait.SinkExt.html#method.with"><code>with</code></a> method.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.WithFlatMap.html" title="futures::sink::WithFlatMap struct">WithFlatMap</a></td><td class="docblock-short"><p>Sink for the <a href="../../futures/sink/trait.SinkExt.html#method.with_flat_map"><code>with_flat_map</code></a> method.</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="futures::sink::Sink trait">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><tr class="module-item"><td><a class="trait" href="trait.SinkExt.html" title="futures::sink::SinkExt trait">SinkExt</a></td><td class="docblock-short"><p>An extension trait for <code>Sink</code>s that provides a variety of convenient
combinator functions.</p>
</td></tr></table><h2 id="functions" class="section-header"><a href="#functions">Functions</a></h2>
<table><tr class="module-item"><td><a class="fn" href="fn.drain.html" title="futures::sink::drain fn">drain</a></td><td class="docblock-short"><p>Create a sink that will just discard all items given to it.</p>
</td></tr><tr class="module-item"><td><a class="fn" href="fn.unfold.html" title="futures::sink::unfold fn">unfold</a></td><td class="docblock-short"><p>Create a sink from a function which processes one item at a time.</p>
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="futures"></div>
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>