Files
GopherGate/target/doc/futures_util/sink/index.html
2026-02-26 12:00:21 -05:00

9 lines
7.8 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="Asynchronous sinks."><title>futures_util::sink - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="futures_util" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Module sink</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../futures_util/index.html">futures_<wbr>util</a><span class="version">0.3.32</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module sink</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate futures_<wbr>util</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">futures_util</a></div><h1>Module <span>sink</span>&nbsp;<button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/futures_util/sink/mod.rs.html#1-344">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Asynchronous sinks.</p>
<p>This module contains:</p>
<ul>
<li>The <a href="trait.Sink.html" title="trait futures_util::sink::Sink"><code>Sink</code></a> trait, which allows you to asynchronously write data.</li>
<li>The <a href="trait.SinkExt.html" title="trait futures_util::sink::SinkExt"><code>SinkExt</code></a> trait, which provides adapters for chaining and composing
sinks.</li>
</ul>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.Buffer.html" title="struct futures_util::sink::Buffer">Buffer</a></dt><dd>Sink for the <a href="trait.SinkExt.html#method.buffer" title="method futures_util::sink::SinkExt::buffer"><code>buffer</code></a> method.</dd><dt><a class="struct" href="struct.Close.html" title="struct futures_util::sink::Close">Close</a></dt><dd>Future for the <a href="trait.SinkExt.html#method.close" title="method futures_util::sink::SinkExt::close"><code>close</code></a> method.</dd><dt><a class="struct" href="struct.Drain.html" title="struct futures_util::sink::Drain">Drain</a></dt><dd>Sink for the <a href="fn.drain.html" title="fn futures_util::sink::drain"><code>drain</code></a> function.</dd><dt><a class="struct" href="struct.Fanout.html" title="struct futures_util::sink::Fanout">Fanout</a></dt><dd>Sink that clones incoming items and forwards them to two sinks at the same time.</dd><dt><a class="struct" href="struct.Feed.html" title="struct futures_util::sink::Feed">Feed</a></dt><dd>Future for the <a href="trait.SinkExt.html#method.feed" title="method futures_util::sink::SinkExt::feed"><code>feed</code></a> method.</dd><dt><a class="struct" href="struct.Flush.html" title="struct futures_util::sink::Flush">Flush</a></dt><dd>Future for the <a href="trait.SinkExt.html#method.flush" title="method futures_util::sink::SinkExt::flush"><code>flush</code></a> method.</dd><dt><a class="struct" href="struct.Send.html" title="struct futures_util::sink::Send">Send</a></dt><dd>Future for the <a href="trait.SinkExt.html#method.send" title="method futures_util::sink::SinkExt::send"><code>send</code></a> method.</dd><dt><a class="struct" href="struct.SendAll.html" title="struct futures_util::sink::SendAll">SendAll</a></dt><dd>Future for the <a href="trait.SinkExt.html#method.send_all" title="method futures_util::sink::SinkExt::send_all"><code>send_all</code></a> method.</dd><dt><a class="struct" href="struct.SinkErrInto.html" title="struct futures_util::sink::SinkErrInto">Sink<wbr>ErrInto</a></dt><dd>Sink for the <a href="trait.SinkExt.html#method.sink_err_into" title="method futures_util::sink::SinkExt::sink_err_into"><code>sink_err_into</code></a> method.</dd><dt><a class="struct" href="struct.SinkMapErr.html" title="struct futures_util::sink::SinkMapErr">Sink<wbr>MapErr</a></dt><dd>Sink for the <a href="trait.SinkExt.html#method.sink_map_err" title="method futures_util::sink::SinkExt::sink_map_err"><code>sink_map_err</code></a> method.</dd><dt><a class="struct" href="struct.Unfold.html" title="struct futures_util::sink::Unfold">Unfold</a></dt><dd>Sink for the <a href="fn.unfold.html" title="fn futures_util::sink::unfold"><code>unfold</code></a> function.</dd><dt><a class="struct" href="struct.With.html" title="struct futures_util::sink::With">With</a></dt><dd>Sink for the <a href="trait.SinkExt.html#method.with" title="method futures_util::sink::SinkExt::with"><code>with</code></a> method.</dd><dt><a class="struct" href="struct.WithFlatMap.html" title="struct futures_util::sink::WithFlatMap">With<wbr>Flat<wbr>Map</a></dt><dd>Sink for the <a href="trait.SinkExt.html#method.with_flat_map" title="method futures_util::sink::SinkExt::with_flat_map"><code>with_flat_map</code></a> method.</dd></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.Sink.html" title="trait futures_util::sink::Sink">Sink</a></dt><dd>A <code>Sink</code> is a value into which other values can be sent, asynchronously.</dd><dt><a class="trait" href="trait.SinkExt.html" title="trait futures_util::sink::SinkExt">SinkExt</a></dt><dd>An extension trait for <code>Sink</code>s that provides a variety of convenient
combinator functions.</dd></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.drain.html" title="fn futures_util::sink::drain">drain</a></dt><dd>Create a sink that will just discard all items given to it.</dd><dt><a class="fn" href="fn.unfold.html" title="fn futures_util::sink::unfold">unfold</a></dt><dd>Create a sink from a function which processes one item at a time.</dd></dl></section></div></main></body></html>