github-actions[bot]
14 lines
4.8 KiB
HTML
14 lines
4.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="API documentation for the Rust `channel` fn in crate `futures_channel`."><meta name="keywords" content="rust, rustlang, rust-lang, channel"><title>futures_channel::mpsc::channel - 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 fn"><!--[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><a href='../../futures_channel/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class="location"><a href="../index.html">futures_channel</a>::<wbr><a href="index.html">mpsc</a></p><div id="sidebar-vars" data-name="channel" data-ty="fn" 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">Function <a href="../index.html">futures_channel</a>::<wbr><a href="index.html">mpsc</a>::<wbr><a class="fn" href="">channel</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/futures_channel/mpsc/mod.rs.html#364-389" title="goto source code">[src]</a></span></h1><pre class="rust fn">pub fn channel<T>(buffer: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="../../futures_channel/mpsc/struct.Sender.html" title="struct futures_channel::mpsc::Sender">Sender</a><T>, <a class="struct" href="../../futures_channel/mpsc/struct.Receiver.html" title="struct futures_channel::mpsc::Receiver">Receiver</a><T><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></pre><div class="docblock"><p>Creates a bounded mpsc channel for communicating between asynchronous tasks.</p>
|
||
<p>Being bounded, this channel provides backpressure to ensure that the sender
|
||
outpaces the receiver by only a limited amount. The channel's capacity is
|
||
equal to <code>buffer + num-senders</code>. In other words, each sender gets a
|
||
guaranteed slot in the channel capacity, and on top of that there are
|
||
<code>buffer</code> "first come, first serve" slots available to all senders.</p>
|
||
<p>The <a href="../../futures_channel/mpsc/struct.Receiver.html"><code>Receiver</code></a> returned implements the
|
||
<a href="../../futures_core/stream/trait.Stream.html"><code>Stream</code></a> trait, while <a href="../../futures_channel/mpsc/struct.Sender.html"><code>Sender</code></a> implements
|
||
<code>Sink</code>.</p>
|
||
</div></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="futures_channel"></div>
|
||
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |