29 lines
9.0 KiB
HTML
29 lines
9.0 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="A multi-producer, single-consumer queue for sending values across asynchronous tasks."><title>futures_channel::mpsc - 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_channel" 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 mpsc</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../futures_channel/index.html">futures_<wbr>channel</a><span class="version">0.3.32</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module mpsc</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#disconnection" title="Disconnection">Disconnection</a></li><li><a href="#clean-shutdown" title="Clean Shutdown">Clean Shutdown</a></li></ul><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</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>channel</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_channel</a></div><h1>Module <span>mpsc</span> <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_channel/mpsc/mod.rs.html#1-1468">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A multi-producer, single-consumer queue for sending values across
|
|
asynchronous tasks.</p>
|
|
<p>Similarly to the <code>std</code>, channel creation provides <a href="struct.Receiver.html"><code>Receiver</code></a> and
|
|
<a href="struct.Sender.html"><code>Sender</code></a> handles. <a href="struct.Receiver.html"><code>Receiver</code></a> implements <a href="../../futures_core/stream/trait.Stream.html"><code>Stream</code></a> and allows a task to
|
|
read values out of the channel. If there is no message to read from the
|
|
channel, the current task will be notified when a new value is sent.
|
|
<a href="struct.Sender.html"><code>Sender</code></a> implements the <code>Sink</code> trait and allows a task to send messages into
|
|
the channel. If the channel is at capacity, the send will be rejected and
|
|
the task will be notified when additional capacity is available. In other
|
|
words, the channel provides backpressure.</p>
|
|
<p>Unbounded channels are also available using the <code>unbounded</code> constructor.</p>
|
|
<h2 id="disconnection"><a class="doc-anchor" href="#disconnection">§</a>Disconnection</h2>
|
|
<p>When all <a href="struct.Sender.html"><code>Sender</code></a> handles have been dropped, it is no longer
|
|
possible to send values into the channel. This is considered the termination
|
|
event of the stream. As such, <a href="../../futures_core/stream/trait.Stream.html#tymethod.poll_next"><code>Receiver::poll_next</code></a>
|
|
will return <code>Ok(Ready(None))</code>.</p>
|
|
<p>If the <a href="struct.Receiver.html"><code>Receiver</code></a> handle is dropped, then messages can no longer
|
|
be read out of the channel. In this case, all further attempts to send will
|
|
result in an error.</p>
|
|
<h2 id="clean-shutdown"><a class="doc-anchor" href="#clean-shutdown">§</a>Clean Shutdown</h2>
|
|
<p>If the <a href="struct.Receiver.html"><code>Receiver</code></a> is simply dropped, then it is possible for
|
|
there to be messages still in the channel that will not be processed. As
|
|
such, it is usually desirable to perform a “clean” shutdown. To do this, the
|
|
receiver will first call <code>close</code>, which will prevent any further messages to
|
|
be sent into the channel. Then, the receiver consumes the channel to
|
|
completion, at which point the receiver can be dropped.</p>
|
|
</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.Receiver.html" title="struct futures_channel::mpsc::Receiver">Receiver</a></dt><dd>The receiving end of a bounded mpsc channel.</dd><dt><a class="struct" href="struct.Recv.html" title="struct futures_channel::mpsc::Recv">Recv</a></dt><dd>Future returned by <a href="struct.Receiver.html#method.recv" title="method futures_channel::mpsc::Receiver::recv"><code>Receiver::recv()</code></a> or <a href="struct.UnboundedReceiver.html#method.recv" title="method futures_channel::mpsc::UnboundedReceiver::recv"><code>UnboundedReceiver::recv()</code></a>.</dd><dt><a class="struct" href="struct.RecvError.html" title="struct futures_channel::mpsc::RecvError">Recv<wbr>Error</a></dt><dd>Error returned by the future returned by <a href="struct.Receiver.html#method.recv" title="method futures_channel::mpsc::Receiver::recv"><code>Receiver::recv()</code></a> or <a href="struct.UnboundedReceiver.html#method.recv" title="method futures_channel::mpsc::UnboundedReceiver::recv"><code>UnboundedReceiver::recv()</code></a>.
|
|
Received when the channel is empty and closed.</dd><dt><a class="struct" href="struct.SendError.html" title="struct futures_channel::mpsc::SendError">Send<wbr>Error</a></dt><dd>The error type for <a href="struct.Sender.html" title="struct futures_channel::mpsc::Sender"><code>Sender</code>s</a> used as <code>Sink</code>s.</dd><dt><a class="struct" href="struct.Sender.html" title="struct futures_channel::mpsc::Sender">Sender</a></dt><dd>The transmission end of a bounded mpsc channel.</dd><dt><a class="struct" href="struct.TrySendError.html" title="struct futures_channel::mpsc::TrySendError">TrySend<wbr>Error</a></dt><dd>The error type returned from <a href="struct.Sender.html#method.try_send" title="method futures_channel::mpsc::Sender::try_send"><code>try_send</code></a>.</dd><dt><a class="struct" href="struct.UnboundedReceiver.html" title="struct futures_channel::mpsc::UnboundedReceiver">Unbounded<wbr>Receiver</a></dt><dd>The receiving end of an unbounded mpsc channel.</dd><dt><a class="struct" href="struct.UnboundedSender.html" title="struct futures_channel::mpsc::UnboundedSender">Unbounded<wbr>Sender</a></dt><dd>The transmission end of an unbounded mpsc channel.</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.TryRecvError.html" title="enum futures_channel::mpsc::TryRecvError">TryRecv<wbr>Error</a></dt><dd>Error returned by <a href="struct.Receiver.html#method.try_recv" title="method futures_channel::mpsc::Receiver::try_recv"><code>Receiver::try_recv</code></a> or <a href="struct.UnboundedReceiver.html#method.try_recv" title="method futures_channel::mpsc::UnboundedReceiver::try_recv"><code>UnboundedReceiver::try_recv</code></a>.</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.channel.html" title="fn futures_channel::mpsc::channel">channel</a></dt><dd>Creates a bounded mpsc channel for communicating between asynchronous tasks.</dd><dt><a class="fn" href="fn.unbounded.html" title="fn futures_channel::mpsc::unbounded">unbounded</a></dt><dd>Creates an unbounded mpsc channel for communicating between asynchronous
|
|
tasks.</dd></dl></section></div></main></body></html> |