204 lines
44 KiB
HTML
204 lines
44 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 queue."><title>ConcurrentQueue in 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="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="icon" href="https://raw.githubusercontent.com/smol-rs/smol/master/assets/images/logo_fullsize_transparent.png"></head><body class="rustdoc struct"><!--[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"><section id="rustdoc-toc"><h2 class="location"><a href="#">Concurrent<wbr>Queue</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#examples" title="Examples">Examples</a></li></ul><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.bounded" title="bounded">bounded</a></li><li><a href="#method.capacity" title="capacity">capacity</a></li><li><a href="#method.close" title="close">close</a></li><li><a href="#method.force_push" title="force_push">force_push</a></li><li><a href="#method.is_closed" title="is_closed">is_closed</a></li><li><a href="#method.is_empty" title="is_empty">is_empty</a></li><li><a href="#method.is_full" title="is_full">is_full</a></li><li><a href="#method.len" title="len">len</a></li><li><a href="#method.pop" title="pop">pop</a></li><li><a href="#method.push" title="push">push</a></li><li><a href="#method.try_iter" title="try_iter">try_iter</a></li><li><a href="#method.unbounded" title="unbounded">unbounded</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Debug-for-ConcurrentQueue%3CT%3E" title="Debug">Debug</a></li><li><a href="#impl-RefUnwindSafe-for-ConcurrentQueue%3CT%3E" title="RefUnwindSafe">RefUnwindSafe</a></li><li><a href="#impl-Send-for-ConcurrentQueue%3CT%3E" title="Send">Send</a></li><li><a href="#impl-Sync-for-ConcurrentQueue%3CT%3E" title="Sync">Sync</a></li><li><a href="#impl-UnwindSafe-for-ConcurrentQueue%3CT%3E" title="UnwindSafe">UnwindSafe</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-ConcurrentQueue%3CT%3E" title="!Freeze">!Freeze</a></li><li><a href="#impl-Unpin-for-ConcurrentQueue%3CT%3E" title="Unpin">Unpin</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T" title="Any">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T" title="Borrow<T>">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T" title="BorrowMut<T>">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-T" title="From<T>">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-T" title="Into<U>">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-T" title="TryFrom<U>">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-T" title="TryInto<U>">TryInto<U></a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate concurrent_<wbr>queue</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">concurrent_queue</a></span><h1>Struct <span class="struct">ConcurrentQueue</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#113">Source</a> </span></div><pre class="rust item-decl"><code>pub struct ConcurrentQueue<T>(<span class="comment">/* private fields */</span>);</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A concurrent queue.</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, PopError, PushError};
|
|
|
|
<span class="kw">let </span>q = ConcurrentQueue::bounded(<span class="number">2</span>);
|
|
|
|
<span class="macro">assert_eq!</span>(q.push(<span class="string">'a'</span>), <span class="prelude-val">Ok</span>(()));
|
|
<span class="macro">assert_eq!</span>(q.push(<span class="string">'b'</span>), <span class="prelude-val">Ok</span>(()));
|
|
<span class="macro">assert_eq!</span>(q.push(<span class="string">'c'</span>), <span class="prelude-val">Err</span>(PushError::Full(<span class="string">'c'</span>)));
|
|
|
|
<span class="macro">assert_eq!</span>(q.pop(), <span class="prelude-val">Ok</span>(<span class="string">'a'</span>));
|
|
<span class="macro">assert_eq!</span>(q.pop(), <span class="prelude-val">Ok</span>(<span class="string">'b'</span>));
|
|
<span class="macro">assert_eq!</span>(q.pop(), <span class="prelude-val">Err</span>(PopError::Empty));</code></pre></div>
|
|
</div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-ConcurrentQueue%3CT%3E" class="impl"><a class="src rightside" href="../src/concurrent_queue/lib.rs.html#128-461">Source</a><a href="#impl-ConcurrentQueue%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="struct" href="struct.ConcurrentQueue.html" title="struct concurrent_queue::ConcurrentQueue">ConcurrentQueue</a><T></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.bounded" class="method"><a class="src rightside" href="../src/concurrent_queue/lib.rs.html#144-150">Source</a><h4 class="code-header">pub fn <a href="#method.bounded" class="fn">bounded</a>(cap: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>) -> <a class="struct" href="struct.ConcurrentQueue.html" title="struct concurrent_queue::ConcurrentQueue">ConcurrentQueue</a><T></h4></section></summary><div class="docblock"><p>Creates a new bounded queue.</p>
|
|
<p>The queue allocates enough space for <code>cap</code> items.</p>
|
|
<h5 id="panics"><a class="doc-anchor" href="#panics">§</a>Panics</h5>
|
|
<p>If the capacity is zero, this constructor will panic.</p>
|
|
<h5 id="examples-1"><a class="doc-anchor" href="#examples-1">§</a>Examples</h5>
|
|
<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::<i32>::bounded(<span class="number">100</span>);</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.unbounded" class="method"><a class="src rightside" href="../src/concurrent_queue/lib.rs.html#152-166">Source</a><h4 class="code-header">pub const fn <a href="#method.unbounded" class="fn">unbounded</a>() -> <a class="struct" href="struct.ConcurrentQueue.html" title="struct concurrent_queue::ConcurrentQueue">ConcurrentQueue</a><T></h4></section></summary><div class="docblock"><p>Creates a new unbounded queue.</p>
|
|
<h5 id="examples-2"><a class="doc-anchor" href="#examples-2">§</a>Examples</h5>
|
|
<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::<i32>::unbounded();</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.push" class="method"><a class="src rightside" href="../src/concurrent_queue/lib.rs.html#197-203">Source</a><h4 class="code-header">pub fn <a href="#method.push" class="fn">push</a>(&self, value: T) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.unit.html">()</a>, <a class="enum" href="enum.PushError.html" title="enum concurrent_queue::PushError">PushError</a><T>></h4></section></summary><div class="docblock"><p>Attempts to push an item into the queue.</p>
|
|
<p>If the queue is full or closed, the item is returned back as an error.</p>
|
|
<h5 id="examples-3"><a class="doc-anchor" href="#examples-3">§</a>Examples</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>concurrent_queue::{ConcurrentQueue, PushError};
|
|
|
|
<span class="kw">let </span>q = ConcurrentQueue::bounded(<span class="number">1</span>);
|
|
|
|
<span class="comment">// Push succeeds because there is space in the queue.
|
|
</span><span class="macro">assert_eq!</span>(q.push(<span class="number">10</span>), <span class="prelude-val">Ok</span>(()));
|
|
|
|
<span class="comment">// Push errors because the queue is now full.
|
|
</span><span class="macro">assert_eq!</span>(q.push(<span class="number">20</span>), <span class="prelude-val">Err</span>(PushError::Full(<span class="number">20</span>)));
|
|
|
|
<span class="comment">// Close the queue, which will prevent further pushes.
|
|
</span>q.close();
|
|
|
|
<span class="comment">// Pushing now errors indicating the queue is closed.
|
|
</span><span class="macro">assert_eq!</span>(q.push(<span class="number">20</span>), <span class="prelude-val">Err</span>(PushError::Closed(<span class="number">20</span>)));
|
|
|
|
<span class="comment">// Pop the single item in the queue.
|
|
</span><span class="macro">assert_eq!</span>(q.pop(), <span class="prelude-val">Ok</span>(<span class="number">10</span>));
|
|
|
|
<span class="comment">// Even though there is space, no more items can be pushed.
|
|
</span><span class="macro">assert_eq!</span>(q.push(<span class="number">20</span>), <span class="prelude-val">Err</span>(PushError::Closed(<span class="number">20</span>)));</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.force_push" class="method"><a class="src rightside" href="../src/concurrent_queue/lib.rs.html#241-251">Source</a><h4 class="code-header">pub fn <a href="#method.force_push" class="fn">force_push</a>(&self, value: T) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><T>, <a class="struct" href="struct.ForcePushError.html" title="struct concurrent_queue::ForcePushError">ForcePushError</a><T>></h4></section></summary><div class="docblock"><p>Push an element into the queue, potentially displacing another element.</p>
|
|
<p>Attempts to push an element into the queue. If the queue is full, one item from the
|
|
queue is replaced with the provided item. The displaced item is returned as <code>Some(T)</code>.
|
|
If the queue is closed, an error is returned.</p>
|
|
<h5 id="examples-4"><a class="doc-anchor" href="#examples-4">§</a>Examples</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>concurrent_queue::{ConcurrentQueue, ForcePushError, PushError};
|
|
|
|
<span class="kw">let </span>q = ConcurrentQueue::bounded(<span class="number">3</span>);
|
|
|
|
<span class="comment">// We can push to the queue.
|
|
</span><span class="kw">for </span>i <span class="kw">in </span><span class="number">1</span>..=<span class="number">3 </span>{
|
|
<span class="macro">assert_eq!</span>(q.force_push(i), <span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>));
|
|
}
|
|
|
|
<span class="comment">// Push errors because the queue is now full.
|
|
</span><span class="macro">assert_eq!</span>(q.push(<span class="number">4</span>), <span class="prelude-val">Err</span>(PushError::Full(<span class="number">4</span>)));
|
|
|
|
<span class="comment">// Pushing a new value replaces the old ones.
|
|
</span><span class="macro">assert_eq!</span>(q.force_push(<span class="number">5</span>), <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(<span class="number">1</span>)));
|
|
<span class="macro">assert_eq!</span>(q.force_push(<span class="number">6</span>), <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(<span class="number">2</span>)));
|
|
|
|
<span class="comment">// Close the queue to stop further pushes.
|
|
</span>q.close();
|
|
|
|
<span class="comment">// Pushing will return an error.
|
|
</span><span class="macro">assert_eq!</span>(q.force_push(<span class="number">7</span>), <span class="prelude-val">Err</span>(ForcePushError(<span class="number">7</span>)));
|
|
|
|
<span class="comment">// Popping items will return the force-pushed ones.
|
|
</span><span class="macro">assert_eq!</span>(q.pop(), <span class="prelude-val">Ok</span>(<span class="number">3</span>));
|
|
<span class="macro">assert_eq!</span>(q.pop(), <span class="prelude-val">Ok</span>(<span class="number">5</span>));
|
|
<span class="macro">assert_eq!</span>(q.pop(), <span class="prelude-val">Ok</span>(<span class="number">6</span>));</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.pop" class="method"><a class="src rightside" href="../src/concurrent_queue/lib.rs.html#278-284">Source</a><h4 class="code-header">pub fn <a href="#method.pop" class="fn">pop</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <a class="enum" href="enum.PopError.html" title="enum concurrent_queue::PopError">PopError</a>></h4></section></summary><div class="docblock"><p>Attempts to pop an item from the queue.</p>
|
|
<p>If the queue is empty, an error is returned.</p>
|
|
<h5 id="examples-5"><a class="doc-anchor" href="#examples-5">§</a>Examples</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>concurrent_queue::{ConcurrentQueue, PopError};
|
|
|
|
<span class="kw">let </span>q = ConcurrentQueue::bounded(<span class="number">1</span>);
|
|
|
|
<span class="comment">// Pop errors when the queue is empty.
|
|
</span><span class="macro">assert_eq!</span>(q.pop(), <span class="prelude-val">Err</span>(PopError::Empty));
|
|
|
|
<span class="comment">// Push one item and close the queue.
|
|
</span><span class="macro">assert_eq!</span>(q.push(<span class="number">10</span>), <span class="prelude-val">Ok</span>(()));
|
|
q.close();
|
|
|
|
<span class="comment">// Remaining items can be popped.
|
|
</span><span class="macro">assert_eq!</span>(q.pop(), <span class="prelude-val">Ok</span>(<span class="number">10</span>));
|
|
|
|
<span class="comment">// Again, pop errors when the queue is empty,
|
|
// but now also indicates that the queue is closed.
|
|
</span><span class="macro">assert_eq!</span>(q.pop(), <span class="prelude-val">Err</span>(PopError::Closed));</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.try_iter" class="method"><a class="src rightside" href="../src/concurrent_queue/lib.rs.html#311-313">Source</a><h4 class="code-header">pub fn <a href="#method.try_iter" class="fn">try_iter</a>(&self) -> <a class="struct" href="struct.TryIter.html" title="struct concurrent_queue::TryIter">TryIter</a><'_, T> <a href="#" class="tooltip" data-notable-ty="TryIter<'_, T>">ⓘ</a></h4></section></summary><div class="docblock"><p>Get an iterator over the items in the queue.</p>
|
|
<p>The iterator will continue until the queue is empty or closed. It will never block;
|
|
if the queue is empty, the iterator will return <code>None</code>. If new items are pushed into
|
|
the queue, the iterator may return <code>Some</code> in the future after returning <code>None</code>.</p>
|
|
<h5 id="examples-6"><a class="doc-anchor" href="#examples-6">§</a>Examples</h5>
|
|
<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::bounded(<span class="number">5</span>);
|
|
q.push(<span class="number">1</span>).unwrap();
|
|
q.push(<span class="number">2</span>).unwrap();
|
|
q.push(<span class="number">3</span>).unwrap();
|
|
|
|
<span class="kw">let </span><span class="kw-2">mut </span>iter = q.try_iter();
|
|
<span class="macro">assert_eq!</span>(iter.by_ref().sum::<i32>(), <span class="number">6</span>);
|
|
<span class="macro">assert_eq!</span>(iter.next(), <span class="prelude-val">None</span>);
|
|
|
|
<span class="comment">// Pushing more items will make them available to the iterator.
|
|
</span>q.push(<span class="number">4</span>).unwrap();
|
|
<span class="macro">assert_eq!</span>(iter.next(), <span class="prelude-val">Some</span>(<span class="number">4</span>));
|
|
<span class="macro">assert_eq!</span>(iter.next(), <span class="prelude-val">None</span>);</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_empty" class="method"><a class="src rightside" href="../src/concurrent_queue/lib.rs.html#328-334">Source</a><h4 class="code-header">pub fn <a href="#method.is_empty" class="fn">is_empty</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns <code>true</code> if the queue is empty.</p>
|
|
<h5 id="examples-7"><a class="doc-anchor" href="#examples-7">§</a>Examples</h5>
|
|
<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::<i32>::unbounded();
|
|
|
|
<span class="macro">assert!</span>(q.is_empty());
|
|
q.push(<span class="number">1</span>).unwrap();
|
|
<span class="macro">assert!</span>(!q.is_empty());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_full" class="method"><a class="src rightside" href="../src/concurrent_queue/lib.rs.html#351-357">Source</a><h4 class="code-header">pub fn <a href="#method.is_full" class="fn">is_full</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns <code>true</code> if the queue is full.</p>
|
|
<p>An unbounded queue is never full.</p>
|
|
<h5 id="examples-8"><a class="doc-anchor" href="#examples-8">§</a>Examples</h5>
|
|
<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::bounded(<span class="number">1</span>);
|
|
|
|
<span class="macro">assert!</span>(!q.is_full());
|
|
q.push(<span class="number">1</span>).unwrap();
|
|
<span class="macro">assert!</span>(q.is_full());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.len" class="method"><a class="src rightside" href="../src/concurrent_queue/lib.rs.html#375-381">Source</a><h4 class="code-header">pub fn <a href="#method.len" class="fn">len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the number of items in the queue.</p>
|
|
<h5 id="examples-9"><a class="doc-anchor" href="#examples-9">§</a>Examples</h5>
|
|
<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();
|
|
<span class="macro">assert_eq!</span>(q.len(), <span class="number">0</span>);
|
|
|
|
<span class="macro">assert_eq!</span>(q.push(<span class="number">10</span>), <span class="prelude-val">Ok</span>(()));
|
|
<span class="macro">assert_eq!</span>(q.len(), <span class="number">1</span>);
|
|
|
|
<span class="macro">assert_eq!</span>(q.push(<span class="number">20</span>), <span class="prelude-val">Ok</span>(()));
|
|
<span class="macro">assert_eq!</span>(q.len(), <span class="number">2</span>);</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.capacity" class="method"><a class="src rightside" href="../src/concurrent_queue/lib.rs.html#398-404">Source</a><h4 class="code-header">pub fn <a href="#method.capacity" class="fn">capacity</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>></h4></section></summary><div class="docblock"><p>Returns the capacity of the queue.</p>
|
|
<p>Unbounded queues have infinite capacity, represented as <a href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html#variant.None" title="variant core::option::Option::None"><code>None</code></a>.</p>
|
|
<h5 id="examples-10"><a class="doc-anchor" href="#examples-10">§</a>Examples</h5>
|
|
<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::<i32>::bounded(<span class="number">7</span>);
|
|
<span class="macro">assert_eq!</span>(q.capacity(), <span class="prelude-val">Some</span>(<span class="number">7</span>));
|
|
|
|
<span class="kw">let </span>q = ConcurrentQueue::<i32>::unbounded();
|
|
<span class="macro">assert_eq!</span>(q.capacity(), <span class="prelude-val">None</span>);</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.close" class="method"><a class="src rightside" href="../src/concurrent_queue/lib.rs.html#433-439">Source</a><h4 class="code-header">pub fn <a href="#method.close" class="fn">close</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Closes the queue.</p>
|
|
<p>Returns <code>true</code> if this call closed the queue, or <code>false</code> if it was already closed.</p>
|
|
<p>When a queue is closed, no more items can be pushed but the remaining items can still be
|
|
popped.</p>
|
|
<h5 id="examples-11"><a class="doc-anchor" href="#examples-11">§</a>Examples</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>concurrent_queue::{ConcurrentQueue, PopError, PushError};
|
|
|
|
<span class="kw">let </span>q = ConcurrentQueue::unbounded();
|
|
<span class="macro">assert_eq!</span>(q.push(<span class="number">10</span>), <span class="prelude-val">Ok</span>(()));
|
|
|
|
<span class="macro">assert!</span>(q.close()); <span class="comment">// `true` because this call closes the queue.
|
|
</span><span class="macro">assert!</span>(!q.close()); <span class="comment">// `false` because the queue is already closed.
|
|
|
|
// Cannot push any more items when closed.
|
|
</span><span class="macro">assert_eq!</span>(q.push(<span class="number">20</span>), <span class="prelude-val">Err</span>(PushError::Closed(<span class="number">20</span>)));
|
|
|
|
<span class="comment">// Remaining items can still be popped.
|
|
</span><span class="macro">assert_eq!</span>(q.pop(), <span class="prelude-val">Ok</span>(<span class="number">10</span>));
|
|
|
|
<span class="comment">// When no more items are present, the error is `Closed`.
|
|
</span><span class="macro">assert_eq!</span>(q.pop(), <span class="prelude-val">Err</span>(PopError::Closed));</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_closed" class="method"><a class="src rightside" href="../src/concurrent_queue/lib.rs.html#454-460">Source</a><h4 class="code-header">pub fn <a href="#method.is_closed" class="fn">is_closed</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns <code>true</code> if the queue is closed.</p>
|
|
<h5 id="examples-12"><a class="doc-anchor" href="#examples-12">§</a>Examples</h5>
|
|
<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::<i32>::unbounded();
|
|
|
|
<span class="macro">assert!</span>(!q.is_closed());
|
|
q.close();
|
|
<span class="macro">assert!</span>(q.is_closed());</code></pre></div>
|
|
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-ConcurrentQueue%3CT%3E" class="impl"><a class="src rightside" href="../src/concurrent_queue/lib.rs.html#463-471">Source</a><a href="#impl-Debug-for-ConcurrentQueue%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.ConcurrentQueue.html" title="struct concurrent_queue::ConcurrentQueue">ConcurrentQueue</a><T></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../src/concurrent_queue/lib.rs.html#464-470">Source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.84.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.84.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><section id="impl-RefUnwindSafe-for-ConcurrentQueue%3CT%3E" class="impl"><a class="src rightside" href="../src/concurrent_queue/lib.rs.html#119">Source</a><a href="#impl-RefUnwindSafe-for-ConcurrentQueue%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.ConcurrentQueue.html" title="struct concurrent_queue::ConcurrentQueue">ConcurrentQueue</a><T></h3></section><section id="impl-Send-for-ConcurrentQueue%3CT%3E" class="impl"><a class="src rightside" href="../src/concurrent_queue/lib.rs.html#115">Source</a><a href="#impl-Send-for-ConcurrentQueue%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.ConcurrentQueue.html" title="struct concurrent_queue::ConcurrentQueue">ConcurrentQueue</a><T></h3></section><section id="impl-Sync-for-ConcurrentQueue%3CT%3E" class="impl"><a class="src rightside" href="../src/concurrent_queue/lib.rs.html#116">Source</a><a href="#impl-Sync-for-ConcurrentQueue%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.ConcurrentQueue.html" title="struct concurrent_queue::ConcurrentQueue">ConcurrentQueue</a><T></h3></section><section id="impl-UnwindSafe-for-ConcurrentQueue%3CT%3E" class="impl"><a class="src rightside" href="../src/concurrent_queue/lib.rs.html#118">Source</a><a href="#impl-UnwindSafe-for-ConcurrentQueue%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.ConcurrentQueue.html" title="struct concurrent_queue::ConcurrentQueue">ConcurrentQueue</a><T></h3></section></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-ConcurrentQueue%3CT%3E" class="impl"><a href="#impl-Freeze-for-ConcurrentQueue%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> !<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.ConcurrentQueue.html" title="struct concurrent_queue::ConcurrentQueue">ConcurrentQueue</a><T></h3></section><section id="impl-Unpin-for-ConcurrentQueue%3CT%3E" class="impl"><a href="#impl-Unpin-for-ConcurrentQueue%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.ConcurrentQueue.html" title="struct concurrent_queue::ConcurrentQueue">ConcurrentQueue</a><T><div class="where">where
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/any.rs.html#138">Source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
|
|
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/any.rs.html#139">Source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.84.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.84.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#209">Source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<div class="where">where
|
|
T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#211">Source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#217">Source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<div class="where">where
|
|
T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#218">Source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#765">Source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#768">Source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
|
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#748-750">Source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<div class="where">where
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#758">Source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
|
|
<p>That is, this conversion is whatever the implementation of
|
|
<code><a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
|
|
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#805-807">Source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<div class="where">where
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#809">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#812">Source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#790-792">Source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<div class="where">where
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#794">Source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#797">Source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div><script type="text/json" id="notable-traits-data">{"TryIter<'_, T>":"<h3>Notable traits for <code><a class=\"struct\" href=\"struct.TryIter.html\" title=\"struct concurrent_queue::TryIter\">TryIter</a><'_, T></code></h3><pre><code><div class=\"where\">impl<T> <a class=\"trait\" href=\"https://doc.rust-lang.org/1.84.0/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a> for <a class=\"struct\" href=\"struct.TryIter.html\" title=\"struct concurrent_queue::TryIter\">TryIter</a><'_, T></div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.84.0/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" class=\"associatedtype\">Item</a> = T;</div>"}</script></section></div></main></body></html> |