26 lines
5.4 KiB
HTML
26 lines
5.4 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="Creates a new sync unbounded channel, and returns `Sender` and `Receiver` of the channel for type T, you can get access to async API of `AsyncSender` and `AsyncReceiver` with `to_sync`, `as_async` or `clone_sync` based on your requirements, by calling them on sender or receiver."><title>unbounded in kanal - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.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" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="kanal" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../kanal/index.html">kanal</a><span class="version">0.1.0-pre8</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">unbounded</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#examples" title="Examples">Examples</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate kanal</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">kanal</a></span><h1>Function <span class="fn">unbounded</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/kanal/lib.rs.html#1511-1519">Source</a> </span></div><pre class="rust item-decl"><code>pub fn unbounded<T>() -> (<a class="struct" href="struct.Sender.html" title="struct kanal::Sender">Sender</a><T>, <a class="struct" href="struct.Receiver.html" title="struct kanal::Receiver">Receiver</a><T>)</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Creates a new sync unbounded channel, and returns <a href="struct.Sender.html" title="struct kanal::Sender"><code>Sender</code></a> and
|
|
<a href="struct.Receiver.html" title="struct kanal::Receiver"><code>Receiver</code></a> of the channel for type T, you can get access to async API
|
|
of <a href="struct.AsyncSender.html" title="struct kanal::AsyncSender"><code>AsyncSender</code></a> and <a href="struct.AsyncReceiver.html" title="struct kanal::AsyncReceiver"><code>AsyncReceiver</code></a> with <code>to_sync</code>, <code>as_async</code> or
|
|
<code>clone_sync</code> based on your requirements, by calling them on sender or
|
|
receiver.</p>
|
|
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::thread::spawn;
|
|
|
|
<span class="kw">let </span>(s, r) = kanal::unbounded(); <span class="comment">// for channel with unbounded size queue, this channel never blocks on send
|
|
|
|
// spawn 8 threads, that will send 100 numbers to the channel reader
|
|
</span><span class="kw">for </span>i <span class="kw">in </span><span class="number">0</span>..<span class="number">8</span>{
|
|
<span class="kw">let </span>s = s.clone();
|
|
spawn(<span class="kw">move </span>|| {
|
|
<span class="kw">for </span>i <span class="kw">in </span><span class="number">1</span>..<span class="number">100</span>{
|
|
s.send(i);
|
|
}
|
|
});
|
|
}
|
|
<span class="comment">// drop local sender so the channel send side gets closed when all of the senders finished their jobs
|
|
</span>drop(s);
|
|
|
|
<span class="kw">let </span>first = r.recv().unwrap(); <span class="comment">// receive first msg
|
|
</span><span class="kw">let </span>total: u32 = first+r.sum::<u32>(); <span class="comment">// the receiver implements iterator so you can call sum to receive sum of rest of messages
|
|
</span><span class="macro">assert_eq!</span>(total, <span class="number">39600</span>);</code></pre></div>
|
|
</div></details></section></div></main></body></html> |