mirror of
https://github.com/rtic-rs/rtic.git
synced 2025-12-21 15:25:19 +01:00
213 lines
No EOL
65 KiB
HTML
213 lines
No EOL
65 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="Base struct for `Queue` and `QueueView`, generic over the `Storage`."><title>QueueInner in heapless::spsc - 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-e56847b5.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="heapless" data-themes="" data-resource-suffix="" data-rustdoc-version="1.91.1 (ed61e7d7e 2025-11-07)" data-channel="1.91.1" data-search-js="search-e256b49e.js" data-stringdex-js="stringdex-c3e638e9.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-6dc2a7f3.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 struct"><!--[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="#">QueueInner</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../heapless/index.html">heapless</a><span class="version">0.9.2</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Queue<wbr>Inner</a></h2><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.as_mut_view" title="as_mut_view">as_mut_view</a></li><li><a href="#method.as_view" title="as_view">as_view</a></li><li><a href="#method.capacity" title="capacity">capacity</a></li><li><a href="#method.dequeue" title="dequeue">dequeue</a></li><li><a href="#method.dequeue_unchecked" title="dequeue_unchecked">dequeue_unchecked</a></li><li><a href="#method.enqueue" title="enqueue">enqueue</a></li><li><a href="#method.enqueue_unchecked" title="enqueue_unchecked">enqueue_unchecked</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.iter" title="iter">iter</a></li><li><a href="#method.iter_mut" title="iter_mut">iter_mut</a></li><li><a href="#method.len" title="len">len</a></li><li><a href="#method.new" title="new">new</a></li><li><a href="#method.peek" title="peek">peek</a></li><li><a href="#method.split" title="split">split</a></li><li><a href="#method.split_const" title="split_const">split_const</a></li><li><a href="#method.split_const-1" title="split_const">split_const</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Debug-for-QueueInner%3CT,+S%3E" title="Debug">Debug</a></li><li><a href="#impl-Drop-for-QueueInner%3CT,+S%3E" title="Drop">Drop</a></li><li><a href="#impl-Eq-for-QueueInner%3CT,+S%3E" title="Eq">Eq</a></li><li><a href="#impl-Hash-for-QueueInner%3CT,+S%3E" title="Hash">Hash</a></li><li><a href="#impl-IntoIterator-for-%26QueueInner%3CT,+S%3E" title="IntoIterator">IntoIterator</a></li><li><a href="#impl-IntoIterator-for-%26mut+QueueInner%3CT,+S%3E" title="IntoIterator">IntoIterator</a></li><li><a href="#impl-PartialEq%3CQueueInner%3CT,+S2%3E%3E-for-QueueInner%3CT,+S%3E" title="PartialEq<QueueInner<T, S2>>">PartialEq<QueueInner<T, S2>></a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-QueueInner%3CT,+S%3E" title="!Freeze">!Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-QueueInner%3CT,+S%3E" title="RefUnwindSafe">RefUnwindSafe</a></li><li><a href="#impl-Send-for-QueueInner%3CT,+S%3E" title="Send">Send</a></li><li><a href="#impl-Sync-for-QueueInner%3CT,+S%3E" title="Sync">Sync</a></li><li><a href="#impl-Unpin-for-QueueInner%3CT,+S%3E" title="Unpin">Unpin</a></li><li><a href="#impl-UnwindSafe-for-QueueInner%3CT,+S%3E" title="UnwindSafe">UnwindSafe</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-CloneToUninit-for-T" title="CloneToUninit">CloneToUninit</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><a href="index.html">In heapless::<wbr>spsc</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">heapless</a>::<wbr><a href="index.html">spsc</a></div><h1>Struct <span class="struct">Queue<wbr>Inner</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/heapless/spsc.rs.html#119-127">Source</a> </span></div><pre class="rust item-decl"><code>pub struct QueueInner<T, S: <a class="trait" href="../storage/trait.Storage.html" title="trait heapless::storage::Storage">Storage</a>> { <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>Base struct for <a href="type.Queue.html" title="type heapless::spsc::Queue"><code>Queue</code></a> and <a href="type.QueueView.html" title="type heapless::spsc::QueueView"><code>QueueView</code></a>, generic over the <a href="../storage/trait.Storage.html" title="trait heapless::storage::Storage"><code>Storage</code></a>.</p>
|
||
<p>In most cases you should use <a href="type.Queue.html" title="type heapless::spsc::Queue"><code>Queue</code></a> or <a href="type.QueueView.html" title="type heapless::spsc::QueueView"><code>QueueView</code></a> directly. Only use this
|
||
struct if you want to write code that’s generic over both.</p>
|
||
</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-QueueInner%3CT,+OwnedStorage%3CN%3E%3E" class="impl"><a class="src rightside" href="../../src/heapless/spsc.rs.html#147-170">Source</a><a href="#impl-QueueInner%3CT,+OwnedStorage%3CN%3E%3E" class="anchor">§</a><h3 class="code-header">impl<T, const N: <a class="primitive" href="https://doc.rust-lang.org/1.91.1/core/primitive.usize.html">usize</a>> <a class="struct" href="struct.QueueInner.html" title="struct heapless::spsc::QueueInner">QueueInner</a><T, <a class="enum" href="../storage/enum.OwnedStorage.html" title="enum heapless::storage::OwnedStorage">OwnedStorage</a><N>></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.new" class="method"><a class="src rightside" href="../../src/heapless/spsc.rs.html#149-159">Source</a><h4 class="code-header">pub const fn <a href="#method.new" class="fn">new</a>() -> Self</h4></section></summary><div class="docblock"><p>Creates an empty queue.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-QueueInner%3CT,+S%3E" class="impl"><a class="src rightside" href="../../src/heapless/spsc.rs.html#172-441">Source</a><a href="#impl-QueueInner%3CT,+S%3E" class="anchor">§</a><h3 class="code-header">impl<T, S: <a class="trait" href="../storage/trait.Storage.html" title="trait heapless::storage::Storage">Storage</a>> <a class="struct" href="struct.QueueInner.html" title="struct heapless::spsc::QueueInner">QueueInner</a><T, S></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.as_view" class="method"><a class="src rightside" href="../../src/heapless/spsc.rs.html#174-176">Source</a><h4 class="code-header">pub fn <a href="#method.as_view" class="fn">as_view</a>(&self) -> &<a class="type" href="type.QueueView.html" title="type heapless::spsc::QueueView">QueueView</a><T></h4></section></summary><div class="docblock"><p>Get a reference to the <code>Queue</code>, erasing the <code>N</code> const-generic.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.as_mut_view" class="method"><a class="src rightside" href="../../src/heapless/spsc.rs.html#179-181">Source</a><h4 class="code-header">pub fn <a href="#method.as_mut_view" class="fn">as_mut_view</a>(&mut self) -> &mut <a class="type" href="type.QueueView.html" title="type heapless::spsc::QueueView">QueueView</a><T></h4></section></summary><div class="docblock"><p>Get a mutable reference to the <code>Queue</code>, erasing the <code>N</code> const-generic.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.capacity" class="method"><a class="src rightside" href="../../src/heapless/spsc.rs.html#195-197">Source</a><h4 class="code-header">pub fn <a href="#method.capacity" class="fn">capacity</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.91.1/core/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the maximum number of elements the queue can hold.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.len" class="method"><a class="src rightside" href="../../src/heapless/spsc.rs.html#201-209">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.91.1/core/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the number of elements in the queue.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_empty" class="method"><a class="src rightside" href="../../src/heapless/spsc.rs.html#213-215">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.91.1/core/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns whether the queue is empty.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_full" class="method"><a class="src rightside" href="../../src/heapless/spsc.rs.html#219-221">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.91.1/core/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns whether the queue is full.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.iter" class="method"><a class="src rightside" href="../../src/heapless/spsc.rs.html#224-230">Source</a><h4 class="code-header">pub fn <a href="#method.iter" class="fn">iter</a>(&self) -> <a class="struct" href="struct.Iter.html" title="struct heapless::spsc::Iter">Iter</a><'_, T> <a href="#" class="tooltip" data-notable-ty="Iter<'_, T>">ⓘ</a></h4></section></summary><div class="docblock"><p>Iterates from the front of the queue to the back.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.iter_mut" class="method"><a class="src rightside" href="../../src/heapless/spsc.rs.html#233-240">Source</a><h4 class="code-header">pub fn <a href="#method.iter_mut" class="fn">iter_mut</a>(&mut self) -> <a class="struct" href="struct.IterMut.html" title="struct heapless::spsc::IterMut">IterMut</a><'_, T> <a href="#" class="tooltip" data-notable-ty="IterMut<'_, T>">ⓘ</a></h4></section></summary><div class="docblock"><p>Returns an iterator that allows modifying each value.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.enqueue" class="method"><a class="src rightside" href="../../src/heapless/spsc.rs.html#246-248">Source</a><h4 class="code-header">pub fn <a href="#method.enqueue" class="fn">enqueue</a>(&mut self, item: T) -> <a class="enum" href="https://doc.rust-lang.org/1.91.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.91.1/core/primitive.unit.html">()</a>, T></h4></section></summary><div class="docblock"><p>Adds an <code>item</code> to the end of the queue.</p>
|
||
<p>Returns back the <code>item</code> if the queue is full.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.dequeue" class="method"><a class="src rightside" href="../../src/heapless/spsc.rs.html#252-254">Source</a><h4 class="code-header">pub fn <a href="#method.dequeue" class="fn">dequeue</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.91.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><T></h4></section></summary><div class="docblock"><p>Returns the item in the front of the queue, or <code>None</code> if the queue is empty.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.peek" class="method"><a class="src rightside" href="../../src/heapless/spsc.rs.html#271-278">Source</a><h4 class="code-header">pub fn <a href="#method.peek" class="fn">peek</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.91.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.91.1/core/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns a reference to the item in the front of the queue without dequeuing it, or
|
||
<code>None</code> if the queue is empty.</p>
|
||
<h5 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::spsc::Queue;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>queue: Queue<u8, <span class="number">235</span>> = Queue::new();
|
||
<span class="kw">let </span>(<span class="kw-2">mut </span>producer, <span class="kw-2">mut </span>consumer) = queue.split();
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">None</span>, consumer.peek());
|
||
producer.enqueue(<span class="number">1</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="number">1</span>), consumer.peek());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">Some</span>(<span class="number">1</span>), consumer.dequeue());
|
||
<span class="macro">assert_eq!</span>(<span class="prelude-val">None</span>, consumer.peek());</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.enqueue_unchecked" class="method"><a class="src rightside" href="../../src/heapless/spsc.rs.html#318-320">Source</a><h4 class="code-header">pub unsafe fn <a href="#method.enqueue_unchecked" class="fn">enqueue_unchecked</a>(&mut self, item: T)</h4></section></summary><div class="docblock"><p>Adds an <code>item</code> to the end of the queue, without checking if it’s full.</p>
|
||
<h5 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h5>
|
||
<p>If the queue is full, this operation will leak a value (<code>T</code>’s destructor won’t run on
|
||
the value that got overwritten by <code>item</code>), <em>and</em> will allow the <code>dequeue</code> operation
|
||
to create a copy of <code>item</code>, which could result in <code>T</code>’s destructor running on <code>item</code>
|
||
twice.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.dequeue_unchecked" class="method"><a class="src rightside" href="../../src/heapless/spsc.rs.html#363-365">Source</a><h4 class="code-header">pub unsafe fn <a href="#method.dequeue_unchecked" class="fn">dequeue_unchecked</a>(&mut self) -> T</h4></section></summary><div class="docblock"><p>Returns the item in the front of the queue, without checking if there is something in the
|
||
queue.</p>
|
||
<h5 id="safety-1"><a class="doc-anchor" href="#safety-1">§</a>Safety</h5>
|
||
<p>The queue must not be empty. Calling this on an empty queue causes <a href="https://doc.rust-lang.org/reference/behavior-considered-undefined.html">undefined behavior</a>.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.split" class="method"><a class="src rightside" href="../../src/heapless/spsc.rs.html#435-440">Source</a><h4 class="code-header">pub fn <a href="#method.split" class="fn">split</a>(&mut self) -> (<a class="struct" href="struct.Producer.html" title="struct heapless::spsc::Producer">Producer</a><'_, T>, <a class="struct" href="struct.Consumer.html" title="struct heapless::spsc::Consumer">Consumer</a><'_, T>)</h4></section></summary><div class="docblock"><p>Splits a queue into producer and consumer endpoints.</p>
|
||
<p>If you need this function in a <code>const</code> context,
|
||
check out <a href="struct.QueueInner.html#method.split_const" title="method heapless::spsc::QueueInner::split_const"><code>Queue::split_const</code></a> and <a href="struct.QueueInner.html#method.split_const" title="method heapless::spsc::QueueInner::split_const"><code>QueueView::split_const</code></a>.</p>
|
||
<h5 id="examples-1"><a class="doc-anchor" href="#examples-1">§</a>Examples</h5>
|
||
<p>Create a queue and split it at runtime</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>queue: Queue<(), <span class="number">4</span>> = Queue::new();
|
||
<span class="kw">let </span>(<span class="kw-2">mut </span>producer, <span class="kw-2">mut </span>consumer) = queue.split();
|
||
producer.enqueue(()).unwrap();
|
||
<span class="macro">assert_eq!</span>(consumer.dequeue(), <span class="prelude-val">Some</span>(()));</code></pre></div>
|
||
<p>Create a queue at compile time, split it at runtime,
|
||
and pass it to an interrupt handler via a mutex.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>core::cell::RefCell;
|
||
<span class="kw">use </span>critical_section::Mutex;
|
||
<span class="kw">use </span>heapless::spsc::{Producer, Queue};
|
||
|
||
<span class="kw">static </span>PRODUCER: Mutex<RefCell<<span class="prelude-ty">Option</span><Producer<<span class="lifetime">'static</span>, ()>>>> =
|
||
{ Mutex::new(RefCell::new(<span class="prelude-val">None</span>)) };
|
||
|
||
<span class="kw">fn </span>interrupt() {
|
||
<span class="kw">let </span><span class="kw-2">mut </span>producer = {
|
||
<span class="kw">static </span><span class="kw-2">mut </span>P: <span class="prelude-ty">Option</span><Producer<<span class="lifetime">'static</span>, ()>> = <span class="prelude-val">None</span>;
|
||
<span class="comment">// SAFETY: Mutable access to `P` is allowed exclusively in this scope
|
||
// and `interrupt` cannot be called directly or preempt itself.
|
||
</span><span class="kw">unsafe </span>{ <span class="kw-2">&mut </span>P }
|
||
}
|
||
.get_or_insert_with(|| {
|
||
critical_section::with(|cs| PRODUCER.borrow_ref_mut(cs).take().unwrap())
|
||
});
|
||
|
||
producer.enqueue(()).unwrap();
|
||
}
|
||
|
||
<span class="kw">fn </span>main() {
|
||
<span class="kw">let </span><span class="kw-2">mut </span>consumer = {
|
||
<span class="kw">let </span>(p, c) = {
|
||
<span class="kw">static </span><span class="kw-2">mut </span>Q: Queue<(), <span class="number">4</span>> = Queue::new();
|
||
<span class="comment">// SAFETY: `Q` is only accessible in this scope
|
||
// and `main` is only called once.
|
||
</span><span class="attr">#[allow(static_mut_refs)]
|
||
</span><span class="kw">unsafe </span>{
|
||
Q.split()
|
||
}
|
||
};
|
||
|
||
critical_section::with(<span class="kw">move </span>|cs| {
|
||
<span class="kw">let </span><span class="kw-2">mut </span>producer = PRODUCER.borrow_ref_mut(cs);
|
||
<span class="kw-2">*</span>producer = <span class="prelude-val">Some</span>(p);
|
||
});
|
||
|
||
c
|
||
};
|
||
|
||
<span class="comment">// Interrupt occurs.
|
||
|
||
</span>consumer.dequeue().unwrap();
|
||
}</code></pre></div></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-QueueInner%3CT,+OwnedStorage%3CN%3E%3E-1" class="impl"><a class="src rightside" href="../../src/heapless/spsc.rs.html#443-500">Source</a><a href="#impl-QueueInner%3CT,+OwnedStorage%3CN%3E%3E-1" class="anchor">§</a><h3 class="code-header">impl<T, const N: <a class="primitive" href="https://doc.rust-lang.org/1.91.1/core/primitive.usize.html">usize</a>> <a class="struct" href="struct.QueueInner.html" title="struct heapless::spsc::QueueInner">QueueInner</a><T, <a class="enum" href="../storage/enum.OwnedStorage.html" title="enum heapless::storage::OwnedStorage">OwnedStorage</a><N>></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.split_const" class="method"><a class="src rightside" href="../../src/heapless/spsc.rs.html#497-499">Source</a><h4 class="code-header">pub const fn <a href="#method.split_const" class="fn">split_const</a>(&mut self) -> (<a class="struct" href="struct.Producer.html" title="struct heapless::spsc::Producer">Producer</a><'_, T>, <a class="struct" href="struct.Consumer.html" title="struct heapless::spsc::Consumer">Consumer</a><'_, T>)</h4></section></summary><div class="docblock"><p>Splits a queue into producer and consumer endpoints.</p>
|
||
<p>Unlike <a href=""><code>Queue::split</code></a>, this method can be used in a <code>const</code> context</p>
|
||
<h5 id="example"><a class="doc-anchor" href="#example">§</a>Example</h5>
|
||
<p>Create and split a queue at compile time, and pass it to the main
|
||
function and an interrupt handler via a mutex at runtime.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>core::cell::RefCell;
|
||
|
||
<span class="kw">use </span>critical_section::Mutex;
|
||
<span class="kw">use </span>heapless::spsc::{Consumer, Producer, Queue};
|
||
|
||
<span class="kw">static </span>PC: (
|
||
Mutex<RefCell<<span class="prelude-ty">Option</span><Producer<<span class="lifetime">'_</span>, ()>>>>,
|
||
Mutex<RefCell<<span class="prelude-ty">Option</span><Consumer<<span class="lifetime">'_</span>, ()>>>>,
|
||
) = {
|
||
<span class="kw">static </span><span class="kw-2">mut </span>Q: Queue<(), <span class="number">4</span>> = Queue::new();
|
||
<span class="comment">// SAFETY: `Q` is only accessible in this scope.
|
||
</span><span class="attr">#[allow(static_mut_refs)]
|
||
</span><span class="kw">let </span>(p, c) = <span class="kw">unsafe </span>{ Q.split_const() };
|
||
|
||
(
|
||
Mutex::new(RefCell::new(<span class="prelude-val">Some</span>(p))),
|
||
Mutex::new(RefCell::new(<span class="prelude-val">Some</span>(c))),
|
||
)
|
||
};
|
||
|
||
<span class="kw">fn </span>interrupt() {
|
||
<span class="kw">let </span><span class="kw-2">mut </span>producer = {
|
||
<span class="kw">static </span><span class="kw-2">mut </span>P: <span class="prelude-ty">Option</span><Producer<<span class="lifetime">'_</span>, ()>> = <span class="prelude-val">None</span>;
|
||
<span class="comment">// SAFETY: Mutable access to `P` is allowed exclusively in this scope
|
||
// and `interrupt` cannot be called directly or preempt itself.
|
||
</span><span class="kw">unsafe </span>{ <span class="kw-2">&mut </span>P }
|
||
}
|
||
.get_or_insert_with(|| {
|
||
critical_section::with(|cs| PC.<span class="number">0</span>.borrow_ref_mut(cs).take().unwrap())
|
||
});
|
||
|
||
producer.enqueue(()).unwrap();
|
||
}
|
||
|
||
<span class="kw">fn </span>main() {
|
||
<span class="kw">let </span><span class="kw-2">mut </span>consumer = critical_section::with(|cs| PC.<span class="number">1</span>.borrow_ref_mut(cs).take().unwrap());
|
||
|
||
<span class="comment">// Interrupt occurs.
|
||
|
||
</span>consumer.dequeue().unwrap();
|
||
}</code></pre></div></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-QueueInner%3CT,+ViewStorage%3E" class="impl"><a class="src rightside" href="../../src/heapless/spsc.rs.html#502-559">Source</a><a href="#impl-QueueInner%3CT,+ViewStorage%3E" class="anchor">§</a><h3 class="code-header">impl<T> <a class="struct" href="struct.QueueInner.html" title="struct heapless::spsc::QueueInner">QueueInner</a><T, <a class="enum" href="../storage/enum.ViewStorage.html" title="enum heapless::storage::ViewStorage">ViewStorage</a>></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.split_const-1" class="method"><a class="src rightside" href="../../src/heapless/spsc.rs.html#556-558">Source</a><h4 class="code-header">pub const fn <a href="#method.split_const-1" class="fn">split_const</a>(&mut self) -> (<a class="struct" href="struct.Producer.html" title="struct heapless::spsc::Producer">Producer</a><'_, T>, <a class="struct" href="struct.Consumer.html" title="struct heapless::spsc::Consumer">Consumer</a><'_, T>)</h4></section></summary><div class="docblock"><p>Splits a queue into producer and consumer endpoints.</p>
|
||
<p>Unlike <a href=""><code>Queue::split</code></a>, this method can be used in a <code>const</code> context</p>
|
||
<h5 id="example-1"><a class="doc-anchor" href="#example-1">§</a>Example</h5>
|
||
<p>Create and split a queue at compile time, and pass it to the main
|
||
function and an interrupt handler via a mutex at runtime.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>core::cell::RefCell;
|
||
|
||
<span class="kw">use </span>critical_section::Mutex;
|
||
<span class="kw">use </span>heapless::spsc::{Consumer, Producer, Queue, QueueView};
|
||
|
||
<span class="kw">static </span>PC: (
|
||
Mutex<RefCell<<span class="prelude-ty">Option</span><Producer<<span class="lifetime">'_</span>, ()>>>>,
|
||
Mutex<RefCell<<span class="prelude-ty">Option</span><Consumer<<span class="lifetime">'_</span>, ()>>>>,
|
||
) = {
|
||
<span class="kw">static </span><span class="kw-2">mut </span>Q: <span class="kw-2">&mut </span>QueueView<()> = <span class="kw-2">&mut </span>Queue::<(), <span class="number">4</span>>::new();
|
||
<span class="comment">// SAFETY: `Q` is only accessible in this scope.
|
||
</span><span class="attr">#[allow(static_mut_refs)]
|
||
</span><span class="kw">let </span>(p, c) = <span class="kw">unsafe </span>{ Q.split_const() };
|
||
|
||
(
|
||
Mutex::new(RefCell::new(<span class="prelude-val">Some</span>(p))),
|
||
Mutex::new(RefCell::new(<span class="prelude-val">Some</span>(c))),
|
||
)
|
||
};
|
||
|
||
<span class="kw">fn </span>interrupt() {
|
||
<span class="kw">let </span><span class="kw-2">mut </span>producer = {
|
||
<span class="kw">static </span><span class="kw-2">mut </span>P: <span class="prelude-ty">Option</span><Producer<<span class="lifetime">'_</span>, ()>> = <span class="prelude-val">None</span>;
|
||
<span class="comment">// SAFETY: Mutable access to `P` is allowed exclusively in this scope
|
||
// and `interrupt` cannot be called directly or preempt itself.
|
||
</span><span class="kw">unsafe </span>{ <span class="kw-2">&mut </span>P }
|
||
}
|
||
.get_or_insert_with(|| {
|
||
critical_section::with(|cs| PC.<span class="number">0</span>.borrow_ref_mut(cs).take().unwrap())
|
||
});
|
||
|
||
producer.enqueue(()).unwrap();
|
||
}
|
||
|
||
<span class="kw">fn </span>main() {
|
||
<span class="kw">let </span><span class="kw-2">mut </span>consumer = critical_section::with(|cs| PC.<span class="number">1</span>.borrow_ref_mut(cs).take().unwrap());
|
||
|
||
<span class="comment">// Interrupt occurs.
|
||
|
||
</span>consumer.dequeue().unwrap();
|
||
}</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-QueueInner%3CT,+S%3E" class="impl"><a class="src rightside" href="../../src/heapless/spsc.rs.html#696-704">Source</a><a href="#impl-Debug-for-QueueInner%3CT,+S%3E" class="anchor">§</a><h3 class="code-header">impl<T, S> <a class="trait" href="https://doc.rust-lang.org/1.91.1/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.QueueInner.html" title="struct heapless::spsc::QueueInner">QueueInner</a><T, S><div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.91.1/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>,
|
||
S: <a class="trait" href="../storage/trait.Storage.html" title="trait heapless::storage::Storage">Storage</a>,</div></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/heapless/spsc.rs.html#701-703">Source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.91.1/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.91.1/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.91.1/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.91.1/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Drop-for-QueueInner%3CT,+S%3E" class="impl"><a class="src rightside" href="../../src/heapless/spsc.rs.html#686-694">Source</a><a href="#impl-Drop-for-QueueInner%3CT,+S%3E" class="anchor">§</a><h3 class="code-header">impl<T, S: <a class="trait" href="../storage/trait.Storage.html" title="trait heapless::storage::Storage">Storage</a>> <a class="trait" href="https://doc.rust-lang.org/1.91.1/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop">Drop</a> for <a class="struct" href="struct.QueueInner.html" title="struct heapless::spsc::QueueInner">QueueInner</a><T, S></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.drop" class="method trait-impl"><a class="src rightside" href="../../src/heapless/spsc.rs.html#687-693">Source</a><a href="#method.drop" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.91.1/core/ops/drop/trait.Drop.html#tymethod.drop" class="fn">drop</a>(&mut self)</h4></section></summary><div class='docblock'>Executes the destructor for this type. <a href="https://doc.rust-lang.org/1.91.1/core/ops/drop/trait.Drop.html#tymethod.drop">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Hash-for-QueueInner%3CT,+S%3E" class="impl"><a class="src rightside" href="../../src/heapless/spsc.rs.html#706-717">Source</a><a href="#impl-Hash-for-QueueInner%3CT,+S%3E" class="anchor">§</a><h3 class="code-header">impl<T, S> <a class="trait" href="https://doc.rust-lang.org/1.91.1/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> for <a class="struct" href="struct.QueueInner.html" title="struct heapless::spsc::QueueInner">QueueInner</a><T, S><div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.91.1/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a>,
|
||
S: <a class="trait" href="../storage/trait.Storage.html" title="trait heapless::storage::Storage">Storage</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.hash" class="method trait-impl"><a class="src rightside" href="../../src/heapless/spsc.rs.html#711-716">Source</a><a href="#method.hash" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.91.1/core/hash/trait.Hash.html#tymethod.hash" class="fn">hash</a><H: <a class="trait" href="https://doc.rust-lang.org/1.91.1/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a>>(&self, state: <a class="primitive" href="https://doc.rust-lang.org/1.91.1/core/primitive.reference.html">&mut H</a>)</h4></section></summary><div class='docblock'>Feeds this value into the given <a href="https://doc.rust-lang.org/1.91.1/core/hash/trait.Hasher.html" title="trait core::hash::Hasher"><code>Hasher</code></a>. <a href="https://doc.rust-lang.org/1.91.1/core/hash/trait.Hash.html#tymethod.hash">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.hash_slice" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.3.0">1.3.0</span> · <a class="src" href="https://doc.rust-lang.org/1.91.1/src/core/hash/mod.rs.html#235-237">Source</a></span><a href="#method.hash_slice" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.91.1/core/hash/trait.Hash.html#method.hash_slice" class="fn">hash_slice</a><H>(data: &[Self], state: <a class="primitive" href="https://doc.rust-lang.org/1.91.1/core/primitive.reference.html">&mut H</a>)<div class="where">where
|
||
H: <a class="trait" href="https://doc.rust-lang.org/1.91.1/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a>,
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.91.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Feeds a slice of this type into the given <a href="https://doc.rust-lang.org/1.91.1/core/hash/trait.Hasher.html" title="trait core::hash::Hasher"><code>Hasher</code></a>. <a href="https://doc.rust-lang.org/1.91.1/core/hash/trait.Hash.html#method.hash_slice">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-IntoIterator-for-%26QueueInner%3CT,+S%3E" class="impl"><a class="src rightside" href="../../src/heapless/spsc.rs.html#719-726">Source</a><a href="#impl-IntoIterator-for-%26QueueInner%3CT,+S%3E" class="anchor">§</a><h3 class="code-header">impl<'a, T, S: <a class="trait" href="../storage/trait.Storage.html" title="trait heapless::storage::Storage">Storage</a>> <a class="trait" href="https://doc.rust-lang.org/1.91.1/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a> for &'a <a class="struct" href="struct.QueueInner.html" title="struct heapless::spsc::QueueInner">QueueInner</a><T, S></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Item" class="associatedtype trait-impl"><a class="src rightside" href="../../src/heapless/spsc.rs.html#720">Source</a><a href="#associatedtype.Item" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.91.1/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" class="associatedtype">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/1.91.1/core/primitive.reference.html">&'a T</a></h4></section></summary><div class='docblock'>The type of the elements being iterated over.</div></details><details class="toggle" open><summary><section id="associatedtype.IntoIter" class="associatedtype trait-impl"><a class="src rightside" href="../../src/heapless/spsc.rs.html#721">Source</a><a href="#associatedtype.IntoIter" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.91.1/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" class="associatedtype">IntoIter</a> = <a class="struct" href="struct.Iter.html" title="struct heapless::spsc::Iter">Iter</a><'a, T></h4></section></summary><div class='docblock'>Which kind of iterator are we turning this into?</div></details><details class="toggle method-toggle" open><summary><section id="method.into_iter" class="method trait-impl"><a class="src rightside" href="../../src/heapless/spsc.rs.html#723-725">Source</a><a href="#method.into_iter" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.91.1/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter" class="fn">into_iter</a>(self) -> Self::<a class="associatedtype" href="https://doc.rust-lang.org/1.91.1/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" title="type core::iter::traits::collect::IntoIterator::IntoIter">IntoIter</a></h4></section></summary><div class='docblock'>Creates an iterator from a value. <a href="https://doc.rust-lang.org/1.91.1/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-IntoIterator-for-%26mut+QueueInner%3CT,+S%3E" class="impl"><a class="src rightside" href="../../src/heapless/spsc.rs.html#728-735">Source</a><a href="#impl-IntoIterator-for-%26mut+QueueInner%3CT,+S%3E" class="anchor">§</a><h3 class="code-header">impl<'a, T, S: <a class="trait" href="../storage/trait.Storage.html" title="trait heapless::storage::Storage">Storage</a>> <a class="trait" href="https://doc.rust-lang.org/1.91.1/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a> for &'a mut <a class="struct" href="struct.QueueInner.html" title="struct heapless::spsc::QueueInner">QueueInner</a><T, S></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Item-1" class="associatedtype trait-impl"><a class="src rightside" href="../../src/heapless/spsc.rs.html#729">Source</a><a href="#associatedtype.Item-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.91.1/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" class="associatedtype">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/1.91.1/core/primitive.reference.html">&'a mut T</a></h4></section></summary><div class='docblock'>The type of the elements being iterated over.</div></details><details class="toggle" open><summary><section id="associatedtype.IntoIter-1" class="associatedtype trait-impl"><a class="src rightside" href="../../src/heapless/spsc.rs.html#730">Source</a><a href="#associatedtype.IntoIter-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.91.1/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" class="associatedtype">IntoIter</a> = <a class="struct" href="struct.IterMut.html" title="struct heapless::spsc::IterMut">IterMut</a><'a, T></h4></section></summary><div class='docblock'>Which kind of iterator are we turning this into?</div></details><details class="toggle method-toggle" open><summary><section id="method.into_iter-1" class="method trait-impl"><a class="src rightside" href="../../src/heapless/spsc.rs.html#732-734">Source</a><a href="#method.into_iter-1" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.91.1/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter" class="fn">into_iter</a>(self) -> Self::<a class="associatedtype" href="https://doc.rust-lang.org/1.91.1/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" title="type core::iter::traits::collect::IntoIterator::IntoIter">IntoIter</a></h4></section></summary><div class='docblock'>Creates an iterator from a value. <a href="https://doc.rust-lang.org/1.91.1/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-PartialEq%3CQueueInner%3CT,+S2%3E%3E-for-QueueInner%3CT,+S%3E" class="impl"><a class="src rightside" href="../../src/heapless/spsc.rs.html#586-595">Source</a><a href="#impl-PartialEq%3CQueueInner%3CT,+S2%3E%3E-for-QueueInner%3CT,+S%3E" class="anchor">§</a><h3 class="code-header">impl<T, S, S2> <a class="trait" href="https://doc.rust-lang.org/1.91.1/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><<a class="struct" href="struct.QueueInner.html" title="struct heapless::spsc::QueueInner">QueueInner</a><T, S2>> for <a class="struct" href="struct.QueueInner.html" title="struct heapless::spsc::QueueInner">QueueInner</a><T, S><div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.91.1/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a>,
|
||
S: <a class="trait" href="../storage/trait.Storage.html" title="trait heapless::storage::Storage">Storage</a>,
|
||
S2: <a class="trait" href="../storage/trait.Storage.html" title="trait heapless::storage::Storage">Storage</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.eq" class="method trait-impl"><a class="src rightside" href="../../src/heapless/spsc.rs.html#592-594">Source</a><a href="#method.eq" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.91.1/core/cmp/trait.PartialEq.html#tymethod.eq" class="fn">eq</a>(&self, other: &<a class="struct" href="struct.QueueInner.html" title="struct heapless::spsc::QueueInner">QueueInner</a><T, S2>) -> <a class="primitive" href="https://doc.rust-lang.org/1.91.1/core/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>Tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>.</div></details><details class="toggle method-toggle" open><summary><section id="method.ne" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.91.1/src/core/cmp.rs.html#264">Source</a></span><a href="#method.ne" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.91.1/core/cmp/trait.PartialEq.html#method.ne" class="fn">ne</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/1.91.1/core/primitive.reference.html">&Rhs</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.91.1/core/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>Tests for <code>!=</code>. The default implementation is almost always sufficient,
|
||
and should not be overridden without very good reason.</div></details></div></details><section id="impl-Eq-for-QueueInner%3CT,+S%3E" class="impl"><a class="src rightside" href="../../src/heapless/spsc.rs.html#597">Source</a><a href="#impl-Eq-for-QueueInner%3CT,+S%3E" class="anchor">§</a><h3 class="code-header">impl<T, S: <a class="trait" href="../storage/trait.Storage.html" title="trait heapless::storage::Storage">Storage</a>> <a class="trait" href="https://doc.rust-lang.org/1.91.1/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="struct" href="struct.QueueInner.html" title="struct heapless::spsc::QueueInner">QueueInner</a><T, S><div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.91.1/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a>,</div></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-QueueInner%3CT,+S%3E" class="impl"><a href="#impl-Freeze-for-QueueInner%3CT,+S%3E" class="anchor">§</a><h3 class="code-header">impl<T, S> !<a class="trait" href="https://doc.rust-lang.org/1.91.1/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.QueueInner.html" title="struct heapless::spsc::QueueInner">QueueInner</a><T, S></h3></section><section id="impl-RefUnwindSafe-for-QueueInner%3CT,+S%3E" class="impl"><a href="#impl-RefUnwindSafe-for-QueueInner%3CT,+S%3E" class="anchor">§</a><h3 class="code-header">impl<T, S> <a class="trait" href="https://doc.rust-lang.org/1.91.1/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.QueueInner.html" title="struct heapless::spsc::QueueInner">QueueInner</a><T, S><div class="where">where
|
||
<S as SealedStorage>::Buffer<<a class="struct" href="https://doc.rust-lang.org/1.91.1/core/cell/struct.UnsafeCell.html" title="struct core::cell::UnsafeCell">UnsafeCell</a><<a class="union" href="https://doc.rust-lang.org/1.91.1/core/mem/maybe_uninit/union.MaybeUninit.html" title="union core::mem::maybe_uninit::MaybeUninit">MaybeUninit</a><T>>>: <a class="trait" href="https://doc.rust-lang.org/1.91.1/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a>,</div></h3></section><section id="impl-Send-for-QueueInner%3CT,+S%3E" class="impl"><a href="#impl-Send-for-QueueInner%3CT,+S%3E" class="anchor">§</a><h3 class="code-header">impl<T, S> <a class="trait" href="https://doc.rust-lang.org/1.91.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.QueueInner.html" title="struct heapless::spsc::QueueInner">QueueInner</a><T, S><div class="where">where
|
||
<S as SealedStorage>::Buffer<<a class="struct" href="https://doc.rust-lang.org/1.91.1/core/cell/struct.UnsafeCell.html" title="struct core::cell::UnsafeCell">UnsafeCell</a><<a class="union" href="https://doc.rust-lang.org/1.91.1/core/mem/maybe_uninit/union.MaybeUninit.html" title="union core::mem::maybe_uninit::MaybeUninit">MaybeUninit</a><T>>>: <a class="trait" href="https://doc.rust-lang.org/1.91.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</div></h3></section><section id="impl-Sync-for-QueueInner%3CT,+S%3E" class="impl"><a href="#impl-Sync-for-QueueInner%3CT,+S%3E" class="anchor">§</a><h3 class="code-header">impl<T, S> <a class="trait" href="https://doc.rust-lang.org/1.91.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.QueueInner.html" title="struct heapless::spsc::QueueInner">QueueInner</a><T, S><div class="where">where
|
||
<S as SealedStorage>::Buffer<<a class="struct" href="https://doc.rust-lang.org/1.91.1/core/cell/struct.UnsafeCell.html" title="struct core::cell::UnsafeCell">UnsafeCell</a><<a class="union" href="https://doc.rust-lang.org/1.91.1/core/mem/maybe_uninit/union.MaybeUninit.html" title="union core::mem::maybe_uninit::MaybeUninit">MaybeUninit</a><T>>>: <a class="trait" href="https://doc.rust-lang.org/1.91.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,</div></h3></section><section id="impl-Unpin-for-QueueInner%3CT,+S%3E" class="impl"><a href="#impl-Unpin-for-QueueInner%3CT,+S%3E" class="anchor">§</a><h3 class="code-header">impl<T, S> <a class="trait" href="https://doc.rust-lang.org/1.91.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.QueueInner.html" title="struct heapless::spsc::QueueInner">QueueInner</a><T, S><div class="where">where
|
||
<S as SealedStorage>::Buffer<<a class="struct" href="https://doc.rust-lang.org/1.91.1/core/cell/struct.UnsafeCell.html" title="struct core::cell::UnsafeCell">UnsafeCell</a><<a class="union" href="https://doc.rust-lang.org/1.91.1/core/mem/maybe_uninit/union.MaybeUninit.html" title="union core::mem::maybe_uninit::MaybeUninit">MaybeUninit</a><T>>>: <a class="trait" href="https://doc.rust-lang.org/1.91.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h3></section><section id="impl-UnwindSafe-for-QueueInner%3CT,+S%3E" class="impl"><a href="#impl-UnwindSafe-for-QueueInner%3CT,+S%3E" class="anchor">§</a><h3 class="code-header">impl<T, S> <a class="trait" href="https://doc.rust-lang.org/1.91.1/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.QueueInner.html" title="struct heapless::spsc::QueueInner">QueueInner</a><T, S><div class="where">where
|
||
<S as SealedStorage>::Buffer<<a class="struct" href="https://doc.rust-lang.org/1.91.1/core/cell/struct.UnsafeCell.html" title="struct core::cell::UnsafeCell">UnsafeCell</a><<a class="union" href="https://doc.rust-lang.org/1.91.1/core/mem/maybe_uninit/union.MaybeUninit.html" title="union core::mem::maybe_uninit::MaybeUninit">MaybeUninit</a><T>>>: <a class="trait" href="https://doc.rust-lang.org/1.91.1/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</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.91.1/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.91.1/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.91.1/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.91.1/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.91.1/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.91.1/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.91.1/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.91.1/src/core/borrow.rs.html#212">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.91.1/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.91.1/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.91.1/src/core/borrow.rs.html#214">Source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.91.1/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.91.1/core/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.91.1/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.91.1/src/core/borrow.rs.html#221">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.91.1/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.91.1/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.91.1/src/core/borrow.rs.html#222">Source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.91.1/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.91.1/core/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.91.1/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CloneToUninit-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.91.1/src/core/clone.rs.html#515">Source</a><a href="#impl-CloneToUninit-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.91.1/core/clone/trait.CloneToUninit.html" title="trait core::clone::CloneToUninit">CloneToUninit</a> for T<div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.91.1/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone_to_uninit" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.91.1/src/core/clone.rs.html#517">Source</a><a href="#method.clone_to_uninit" class="anchor">§</a><h4 class="code-header">unsafe fn <a href="https://doc.rust-lang.org/1.91.1/core/clone/trait.CloneToUninit.html#tymethod.clone_to_uninit" class="fn">clone_to_uninit</a>(&self, dest: <a class="primitive" href="https://doc.rust-lang.org/1.91.1/core/primitive.pointer.html">*mut </a><a class="primitive" href="https://doc.rust-lang.org/1.91.1/core/primitive.u8.html">u8</a>)</h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>clone_to_uninit</code>)</span></div></span><div class='docblock'>Performs copy-assignment from <code>self</code> to <code>dest</code>. <a href="https://doc.rust-lang.org/1.91.1/core/clone/trait.CloneToUninit.html#tymethod.clone_to_uninit">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.91.1/src/core/convert/mod.rs.html#785">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.91.1/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.91.1/src/core/convert/mod.rs.html#788">Source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.91.1/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.91.1/src/core/convert/mod.rs.html#767-769">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.91.1/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.91.1/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.91.1/src/core/convert/mod.rs.html#777">Source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.91.1/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.91.1/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.91.1/src/core/convert/mod.rs.html#827-829">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.91.1/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.91.1/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.91.1/src/core/convert/mod.rs.html#831">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.91.1/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.91.1/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.91.1/src/core/convert/mod.rs.html#834">Source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.91.1/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.91.1/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.91.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.91.1/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.91.1/src/core/convert/mod.rs.html#811-813">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.91.1/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.91.1/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.91.1/src/core/convert/mod.rs.html#815">Source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.91.1/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.91.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.91.1/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.91.1/src/core/convert/mod.rs.html#818">Source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.91.1/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.91.1/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.91.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.91.1/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">{"Iter<'_, T>":"<h3>Notable traits for <code><a class=\"struct\" href=\"struct.Iter.html\" title=\"struct heapless::spsc::Iter\">Iter</a><'a, T></code></h3><pre><code><div class=\"where\">impl<'a, T> <a class=\"trait\" href=\"https://doc.rust-lang.org/1.91.1/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a> for <a class=\"struct\" href=\"struct.Iter.html\" title=\"struct heapless::spsc::Iter\">Iter</a><'a, T></div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.91.1/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" class=\"associatedtype\">Item</a> = <a class=\"primitive\" href=\"https://doc.rust-lang.org/1.91.1/core/primitive.reference.html\">&'a T</a>;</div>","IterMut<'_, T>":"<h3>Notable traits for <code><a class=\"struct\" href=\"struct.IterMut.html\" title=\"struct heapless::spsc::IterMut\">IterMut</a><'a, T></code></h3><pre><code><div class=\"where\">impl<'a, T> <a class=\"trait\" href=\"https://doc.rust-lang.org/1.91.1/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a> for <a class=\"struct\" href=\"struct.IterMut.html\" title=\"struct heapless::spsc::IterMut\">IterMut</a><'a, T></div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.91.1/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" class=\"associatedtype\">Item</a> = <a class=\"primitive\" href=\"https://doc.rust-lang.org/1.91.1/core/primitive.reference.html\">&'a mut T</a>;</div>"}</script></section></div></main></body></html> |