31 lines
8.0 KiB
HTML
31 lines
8.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 concurrent multi-producer multi-consumer queue."><title>concurrent_queue - 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="concurrent_queue" 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="../crates.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="icon" href="https://raw.githubusercontent.com/smol-rs/smol/master/assets/images/logo_fullsize_transparent.png"></head><body class="rustdoc mod crate"><!--[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><a class="logo-container" href="../concurrent_queue/index.html"><img src="https://raw.githubusercontent.com/smol-rs/smol/master/assets/images/logo_fullsize_transparent.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../concurrent_queue/index.html"><img src="https://raw.githubusercontent.com/smol-rs/smol/master/assets/images/logo_fullsize_transparent.png" alt="logo"></a><h2><a href="../concurrent_queue/index.html">concurrent_<wbr>queue</a><span class="version">2.5.0</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#examples" title="Examples">Examples</a></li><li><a href="#features" title="Features">Features</a></li></ul><h3><a href="#structs">Crate Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li></ul></section><div id="rustdoc-modnav"></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"><h1>Crate <span>concurrent_queue</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/concurrent_queue/lib.rs.html#1-660">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A concurrent multi-producer multi-consumer queue.</p>
|
|
<p>There are two kinds of queues:</p>
|
|
<ol>
|
|
<li><a href="struct.ConcurrentQueue.html#method.bounded" title="associated function concurrent_queue::ConcurrentQueue::bounded">Bounded</a> queue with limited capacity.</li>
|
|
<li><a href="struct.ConcurrentQueue.html#method.unbounded" title="associated function concurrent_queue::ConcurrentQueue::unbounded">Unbounded</a> queue with unlimited capacity.</li>
|
|
</ol>
|
|
<p>Queues also have the capability to get <a href="struct.ConcurrentQueue.html#method.close" title="method concurrent_queue::ConcurrentQueue::close">closed</a> at any point. When closed, no more items can be
|
|
pushed into the queue, although the remaining items can still be popped.</p>
|
|
<p>These features make it easy to build channels similar to <a href="https://doc.rust-lang.org/1.84.0/std/sync/mpsc/index.html" title="mod std::sync::mpsc"><code>std::sync::mpsc</code></a> on top of this
|
|
crate.</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>concurrent_queue::ConcurrentQueue;
|
|
|
|
<span class="kw">let </span>q = ConcurrentQueue::unbounded();
|
|
q.push(<span class="number">1</span>).unwrap();
|
|
q.push(<span class="number">2</span>).unwrap();
|
|
|
|
<span class="macro">assert_eq!</span>(q.pop(), <span class="prelude-val">Ok</span>(<span class="number">1</span>));
|
|
<span class="macro">assert_eq!</span>(q.pop(), <span class="prelude-val">Ok</span>(<span class="number">2</span>));</code></pre></div>
|
|
<h2 id="features"><a class="doc-anchor" href="#features">§</a>Features</h2>
|
|
<p><code>concurrent-queue</code> uses an <code>std</code> default feature. With this feature enabled, this crate will
|
|
use <a href="https://doc.rust-lang.org/1.84.0/std/thread/fn.yield_now.html" title="fn std::thread::yield_now"><code>std::thread::yield_now</code></a> to avoid busy waiting in tight loops. However, with this
|
|
feature disabled, <a href="https://doc.rust-lang.org/1.84.0/core/hint/fn.spin_loop.html" title="fn core::hint::spin_loop"><code>core::hint::spin_loop</code></a> will be used instead. Disabling <code>std</code> will allow
|
|
this crate to be used on <code>no_std</code> platforms at the potential expense of more busy waiting.</p>
|
|
<p>There is also a <code>portable-atomic</code> feature, which uses a polyfill from the
|
|
<a href="https://crates.io/crates/portable-atomic"><code>portable-atomic</code></a> crate to provide atomic operations on platforms that do not support them.
|
|
See the <a href="https://github.com/taiki-e/portable-atomic/blob/main/README.md#optional-cfg"><code>README</code></a> for the <a href="https://crates.io/crates/portable-atomic"><code>portable-atomic</code></a> crate for more information on how to use it.
|
|
Note that even with this feature enabled, <code>concurrent-queue</code> still requires a global allocator
|
|
to be available. See the documentation for the <a href="https://doc.rust-lang.org/1.84.0/core/alloc/global/trait.GlobalAlloc.html" title="trait core::alloc::global::GlobalAlloc"><code>std::alloc::GlobalAlloc</code></a> trait for more
|
|
information.</p>
|
|
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.ConcurrentQueue.html" title="struct concurrent_queue::ConcurrentQueue">Concurrent<wbr>Queue</a></div><div class="desc docblock-short">A concurrent queue.</div></li><li><div class="item-name"><a class="struct" href="struct.ForcePushError.html" title="struct concurrent_queue::ForcePushError">Force<wbr>Push<wbr>Error</a></div><div class="desc docblock-short">Error that occurs when force-pushing into a full queue.</div></li><li><div class="item-name"><a class="struct" href="struct.TryIter.html" title="struct concurrent_queue::TryIter">TryIter</a></div><div class="desc docblock-short">An iterator that pops items from a <a href="struct.ConcurrentQueue.html" title="struct concurrent_queue::ConcurrentQueue"><code>ConcurrentQueue</code></a>.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.PopError.html" title="enum concurrent_queue::PopError">PopError</a></div><div class="desc docblock-short">Error which occurs when popping from an empty queue.</div></li><li><div class="item-name"><a class="enum" href="enum.PushError.html" title="enum concurrent_queue::PushError">Push<wbr>Error</a></div><div class="desc docblock-short">Error which occurs when pushing into a full or closed queue.</div></li></ul></section></div></main></body></html> |