mirror of
https://github.com/rust-embedded/heapless.git
synced 2025-09-30 14:00:29 +00:00
deploy: d3be15450653eeb2c2b24c24aa2b0be7ccbf80fd
This commit is contained in:
korken89
parent
08ca49a7fd
commit
388b713a94
@ -1,6 +1,6 @@
|
||||
<!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="Fixed capacity Single Producer Single Consumer (SPSC) queue"><meta name="keywords" content="rust, rustlang, rust-lang, spsc"><title>heapless::spsc - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><script src="../../crates.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../../heapless/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><h2 class="location">Module spsc</h2><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li></ul></div><div id="sidebar-vars" data-name="spsc" data-ty="mod" data-relpath="./"></div><script defer src="./sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img src="../../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img src="../../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">heapless</a>::<wbr><a class="mod" href="#">spsc</a><button id="copy-path" onclick="copy_path(this)" title="copy path"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item import" title="Copy item import to clipboard"></button></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/heapless/spsc.rs.html#1-906" title="goto source code">[src]</a></span></h1><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Fixed capacity Single Producer Single Consumer (SPSC) queue</p>
|
||||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../../heapless/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><h2 class="location">Module spsc</h2><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li></ul></div><div id="sidebar-vars" data-name="spsc" data-ty="mod" data-relpath="./"></div><script defer src="./sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img src="../../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img src="../../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">heapless</a>::<wbr><a class="mod" href="#">spsc</a><button id="copy-path" onclick="copy_path(this)" title="copy path"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item import" title="Copy item import to clipboard"></button></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/heapless/spsc.rs.html#1-908" title="goto source code">[src]</a></span></h1><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Fixed capacity Single Producer Single Consumer (SPSC) queue</p>
|
||||
<p>Implementation based on <a href="https://www.codeproject.com/Articles/43510/Lock-Free-Single-Producer-Single-Consumer-Circular">https://www.codeproject.com/Articles/43510/Lock-Free-Single-Producer-Single-Consumer-Circular</a></p>
|
||||
<p>NOTE: This module is not available on targets that do <em>not</em> support atomic loads, e.g. RISC-V
|
||||
cores w/o the A (Atomic) extension</p>
|
||||
|
||||
@ -31,7 +31,7 @@
|
||||
<span class="kw">for</span> <span class="ident">x</span> <span class="kw">in</span> <span class="kw-2">&</span><span class="ident">deque</span> {
|
||||
<span class="macro">println!</span>(<span class="string">"{}"</span>, <span class="ident">x</span>);
|
||||
}</pre></div>
|
||||
</div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl" class="impl has-srclink"><h3 class="code-header in-band">impl<T, const N: usize> <a class="struct" href="struct.Deque.html" title="struct heapless::Deque">Deque</a><T, N></h3><a href="#impl" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#54-360" title="goto source code">[src]</a></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.new" class="method has-srclink"><h4 class="code-header">pub const fn <a href="#method.new" class="fnname">new</a>() -> Self</h4><a href="#method.new" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#70-80" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Constructs a new, empty deque with a fixed capacity of <code>N</code></p>
|
||||
</div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle" open><summary><div id="impl" class="impl has-srclink"><h3 class="code-header in-band">impl<T, const N: usize> <a class="struct" href="struct.Deque.html" title="struct heapless::Deque">Deque</a><T, N></h3><a href="#impl" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#54-359" title="goto source code">[src]</a></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.new" class="method has-srclink"><h4 class="code-header">pub const fn <a href="#method.new" class="fnname">new</a>() -> Self</h4><a href="#method.new" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#70-80" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Constructs a new, empty deque with a fixed capacity of <code>N</code></p>
|
||||
<h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">use</span> <span class="ident">heapless::Deque</span>;
|
||||
@ -47,39 +47,39 @@
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.is_empty" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.is_empty" class="fnname">is_empty</a>(&self) -> bool</h4><a href="#method.is_empty" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#134-136" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Returns whether the deque is empty.</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.is_full" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.is_full" class="fnname">is_full</a>(&self) -> bool</h4><a href="#method.is_full" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#139-141" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Returns whether the deque is full (i.e. if <code>len() == capacity()</code>.</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.as_slices" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.as_slices" class="fnname">as_slices</a>(&self) -> (&[T], &[T])</h4><a href="#method.as_slices" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#144-167" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Returns a pair of slices which contain, in order, the contents of the <code>Deque</code>.</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.as_mut_slices" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.as_mut_slices" class="fnname">as_mut_slices</a>(&mut self) -> (&mut [T], &mut [T])</h4><a href="#method.as_mut_slices" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#170-193" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Returns a pair of mutable slices which contain, in order, the contents of the <code>Deque</code>.</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.front" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.front" class="fnname">front</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.54.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&T></h4><a href="#method.front" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#196-202" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Provides a reference to the front element, or None if the <code>Deque</code> is empty.</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.front_mut" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.front_mut" class="fnname">front_mut</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.54.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&mut T></h4><a href="#method.front_mut" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#205-211" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Provides a mutable reference to the front element, or None if the <code>Deque</code> is empty.</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.back" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.back" class="fnname">back</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.54.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&T></h4><a href="#method.back" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#214-221" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Provides a reference to the back element, or None if the <code>Deque</code> is empty.</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.back_mut" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.back_mut" class="fnname">back_mut</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.54.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&mut T></h4><a href="#method.back_mut" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#224-231" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Provides a mutable reference to the back element, or None if the <code>Deque</code> is empty.</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.pop_front" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.pop_front" class="fnname">pop_front</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.54.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><T></h4><a href="#method.pop_front" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#234-240" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Removes the item from the front of the deque and returns it, or <code>None</code> if it’s empty</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.pop_back" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.pop_back" class="fnname">pop_back</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.54.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><T></h4><a href="#method.pop_back" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#243-249" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Removes the item from the back of the deque and returns it, or <code>None</code> if it’s empty</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.push_front" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.push_front" class="fnname">push_front</a>(&mut self, item: T) -> <a class="enum" href="https://doc.rust-lang.org/1.54.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><(), T></h4><a href="#method.push_front" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#254-261" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Appends an <code>item</code> to the front of the deque</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.as_mut_slices" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.as_mut_slices" class="fnname">as_mut_slices</a>(&mut self) -> (&mut [T], &mut [T])</h4><a href="#method.as_mut_slices" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#170-192" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Returns a pair of mutable slices which contain, in order, the contents of the <code>Deque</code>.</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.front" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.front" class="fnname">front</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.54.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&T></h4><a href="#method.front" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#195-201" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Provides a reference to the front element, or None if the <code>Deque</code> is empty.</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.front_mut" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.front_mut" class="fnname">front_mut</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.54.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&mut T></h4><a href="#method.front_mut" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#204-210" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Provides a mutable reference to the front element, or None if the <code>Deque</code> is empty.</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.back" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.back" class="fnname">back</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.54.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&T></h4><a href="#method.back" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#213-220" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Provides a reference to the back element, or None if the <code>Deque</code> is empty.</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.back_mut" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.back_mut" class="fnname">back_mut</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.54.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&mut T></h4><a href="#method.back_mut" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#223-230" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Provides a mutable reference to the back element, or None if the <code>Deque</code> is empty.</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.pop_front" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.pop_front" class="fnname">pop_front</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.54.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><T></h4><a href="#method.pop_front" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#233-239" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Removes the item from the front of the deque and returns it, or <code>None</code> if it’s empty</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.pop_back" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.pop_back" class="fnname">pop_back</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.54.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><T></h4><a href="#method.pop_back" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#242-248" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Removes the item from the back of the deque and returns it, or <code>None</code> if it’s empty</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.push_front" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.push_front" class="fnname">push_front</a>(&mut self, item: T) -> <a class="enum" href="https://doc.rust-lang.org/1.54.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><(), T></h4><a href="#method.push_front" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#253-260" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Appends an <code>item</code> to the front of the deque</p>
|
||||
<p>Returns back the <code>item</code> if the deque is full</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.push_back" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.push_back" class="fnname">push_back</a>(&mut self, item: T) -> <a class="enum" href="https://doc.rust-lang.org/1.54.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><(), T></h4><a href="#method.push_back" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#266-273" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Appends an <code>item</code> to the back of the deque</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.push_back" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.push_back" class="fnname">push_back</a>(&mut self, item: T) -> <a class="enum" href="https://doc.rust-lang.org/1.54.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><(), T></h4><a href="#method.push_back" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#265-272" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Appends an <code>item</code> to the back of the deque</p>
|
||||
<p>Returns back the <code>item</code> if the deque is full</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.push_front_unchecked" class="method has-srclink"><h4 class="code-header">pub unsafe fn <a href="#method.push_front_unchecked" class="fnname">push_front_unchecked</a>(&mut self, item: T)</h4><a href="#method.push_front_unchecked" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#307-318" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Appends an <code>item</code> to the front of the deque</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.push_front_unchecked" class="method has-srclink"><h4 class="code-header">pub unsafe fn <a href="#method.push_front_unchecked" class="fnname">push_front_unchecked</a>(&mut self, item: T)</h4><a href="#method.push_front_unchecked" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#306-317" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Appends an <code>item</code> to the front of the deque</p>
|
||||
<h1 id="safety" class="section-header"><a href="#safety">Safety</a></h1>
|
||||
<p>This assumes the deque is not full.</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.push_back_unchecked" class="method has-srclink"><h4 class="code-header">pub unsafe fn <a href="#method.push_back_unchecked" class="fnname">push_back_unchecked</a>(&mut self, item: T)</h4><a href="#method.push_back_unchecked" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#325-335" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Appends an <code>item</code> to the back of the deque</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.push_back_unchecked" class="method has-srclink"><h4 class="code-header">pub unsafe fn <a href="#method.push_back_unchecked" class="fnname">push_back_unchecked</a>(&mut self, item: T)</h4><a href="#method.push_back_unchecked" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#324-334" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Appends an <code>item</code> to the back of the deque</p>
|
||||
<h1 id="safety-1" class="section-header"><a href="#safety-1">Safety</a></h1>
|
||||
<p>This assumes the deque is not full.</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.iter" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.iter" class="fnname">iter</a>(&self) -> Iter<'_, T, N></h4><a href="#method.iter" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#338-347" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Returns an iterator over the deque.</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.iter_mut" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.iter_mut" class="fnname">iter_mut</a>(&mut self) -> IterMut<'_, T, N></h4><a href="#method.iter_mut" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#350-359" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Returns an iterator that allows modifying each value.</p>
|
||||
</div></details></div></details><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-Clone" class="impl has-srclink"><h3 class="code-header in-band">impl<T, const N: usize> <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="struct.Deque.html" title="struct heapless::Deque">Deque</a><T, N> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span></h3><a href="#impl-Clone" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#540-553" title="goto source code">[src]</a></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.clone" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.54.0/core/clone/trait.Clone.html#tymethod.clone" class="fnname">clone</a>(&self) -> Self</h4><a href="#method.clone" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#544-552" title="goto source code">[src]</a></div></summary><div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/1.54.0/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.iter" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.iter" class="fnname">iter</a>(&self) -> Iter<'_, T, N></h4><a href="#method.iter" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#337-346" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Returns an iterator over the deque.</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.iter_mut" class="method has-srclink"><h4 class="code-header">pub fn <a href="#method.iter_mut" class="fnname">iter_mut</a>(&mut self) -> IterMut<'_, T, N></h4><a href="#method.iter_mut" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#349-358" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Returns an iterator that allows modifying each value.</p>
|
||||
</div></details></div></details><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-Clone" class="impl has-srclink"><h3 class="code-header in-band">impl<T, const N: usize> <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="struct.Deque.html" title="struct heapless::Deque">Deque</a><T, N> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span></h3><a href="#impl-Clone" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#539-552" title="goto source code">[src]</a></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.clone" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.54.0/core/clone/trait.Clone.html#tymethod.clone" class="fnname">clone</a>(&self) -> Self</h4><a href="#method.clone" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#543-551" title="goto source code">[src]</a></div></summary><div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/1.54.0/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.clone_from" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.54.0/core/clone/trait.Clone.html#method.clone_from" class="fnname">clone_from</a>(&mut self, source: &Self)</h4><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span><a href="#method.clone_from" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/1.54.0/src/core/clone.rs.html#130" title="goto source code">[src]</a></div></summary><div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/1.54.0/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
||||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-Debug" class="impl has-srclink"><h3 class="code-header in-band">impl<T: <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>, const N: usize> <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.Deque.html" title="struct heapless::Deque">Deque</a><T, N></h3><a href="#impl-Debug" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#378-382" title="goto source code">[src]</a></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.fmt" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.54.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.54.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.54.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4><a href="#method.fmt" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#379-381" title="goto source code">[src]</a></div></summary><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.54.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-Default" class="impl has-srclink"><h3 class="code-header in-band">impl<T, const N: usize> <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="struct.Deque.html" title="struct heapless::Deque">Deque</a><T, N></h3><a href="#impl-Default" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#364-368" title="goto source code">[src]</a></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.default" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.54.0/core/default/trait.Default.html#tymethod.default" class="fnname">default</a>() -> Self</h4><a href="#method.default" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#365-367" title="goto source code">[src]</a></div></summary><div class='docblock'><p>Returns the “default value” for a type. <a href="https://doc.rust-lang.org/1.54.0/core/default/trait.Default.html#tymethod.default">Read more</a></p>
|
||||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-Drop" class="impl has-srclink"><h3 class="code-header in-band">impl<T, const N: usize> <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop">Drop</a> for <a class="struct" href="struct.Deque.html" title="struct heapless::Deque">Deque</a><T, N></h3><a href="#impl-Drop" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#370-376" title="goto source code">[src]</a></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.drop" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.54.0/core/ops/drop/trait.Drop.html#tymethod.drop" class="fnname">drop</a>(&mut self)</h4><a href="#method.drop" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#371-375" title="goto source code">[src]</a></div></summary><div class='docblock'><p>Executes the destructor for this type. <a href="https://doc.rust-lang.org/1.54.0/core/ops/drop/trait.Drop.html#tymethod.drop">Read more</a></p>
|
||||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-IntoIterator" class="impl has-srclink"><h3 class="code-header in-band">impl<T, const N: usize> <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a> for <a class="struct" href="struct.Deque.html" title="struct heapless::Deque">Deque</a><T, N></h3><a href="#impl-IntoIterator" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#400-407" title="goto source code">[src]</a></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Item" class="type trait-impl has-srclink"><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.54.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" class="type">Item</a> = T</h4><a href="#associatedtype.Item" class="anchor"></a></div></summary><div class='docblock'><p>The type of the elements being iterated over.</p>
|
||||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-Debug" class="impl has-srclink"><h3 class="code-header in-band">impl<T: <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>, const N: usize> <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.Deque.html" title="struct heapless::Deque">Deque</a><T, N></h3><a href="#impl-Debug" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#377-381" title="goto source code">[src]</a></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.fmt" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.54.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.54.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.54.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4><a href="#method.fmt" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#378-380" title="goto source code">[src]</a></div></summary><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.54.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-Default" class="impl has-srclink"><h3 class="code-header in-band">impl<T, const N: usize> <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="struct.Deque.html" title="struct heapless::Deque">Deque</a><T, N></h3><a href="#impl-Default" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#363-367" title="goto source code">[src]</a></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.default" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.54.0/core/default/trait.Default.html#tymethod.default" class="fnname">default</a>() -> Self</h4><a href="#method.default" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#364-366" title="goto source code">[src]</a></div></summary><div class='docblock'><p>Returns the “default value” for a type. <a href="https://doc.rust-lang.org/1.54.0/core/default/trait.Default.html#tymethod.default">Read more</a></p>
|
||||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-Drop" class="impl has-srclink"><h3 class="code-header in-band">impl<T, const N: usize> <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop">Drop</a> for <a class="struct" href="struct.Deque.html" title="struct heapless::Deque">Deque</a><T, N></h3><a href="#impl-Drop" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#369-375" title="goto source code">[src]</a></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.drop" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.54.0/core/ops/drop/trait.Drop.html#tymethod.drop" class="fnname">drop</a>(&mut self)</h4><a href="#method.drop" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#370-374" title="goto source code">[src]</a></div></summary><div class='docblock'><p>Executes the destructor for this type. <a href="https://doc.rust-lang.org/1.54.0/core/ops/drop/trait.Drop.html#tymethod.drop">Read more</a></p>
|
||||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-IntoIterator" class="impl has-srclink"><h3 class="code-header in-band">impl<T, const N: usize> <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a> for <a class="struct" href="struct.Deque.html" title="struct heapless::Deque">Deque</a><T, N></h3><a href="#impl-IntoIterator" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#399-406" title="goto source code">[src]</a></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Item" class="type trait-impl has-srclink"><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.54.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" class="type">Item</a> = T</h4><a href="#associatedtype.Item" class="anchor"></a></div></summary><div class='docblock'><p>The type of the elements being iterated over.</p>
|
||||
</div></details><details class="rustdoc-toggle" open><summary><div id="associatedtype.IntoIter" class="type trait-impl has-srclink"><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.54.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" class="type">IntoIter</a> = IntoIter<T, N></h4><a href="#associatedtype.IntoIter" class="anchor"></a></div></summary><div class='docblock'><p>Which kind of iterator are we turning this into?</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.into_iter" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.54.0/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter" class="fnname">into_iter</a>(self) -> Self::<a class="type" href="https://doc.rust-lang.org/1.54.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" title="type core::iter::traits::collect::IntoIterator::IntoIter">IntoIter</a></h4><a href="#method.into_iter" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#404-406" title="goto source code">[src]</a></div></summary><div class='docblock'><p>Creates an iterator from a value. <a href="https://doc.rust-lang.org/1.54.0/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter">Read more</a></p>
|
||||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-IntoIterator-1" class="impl has-srclink"><h3 class="code-header in-band">impl<'a, T, const N: usize> <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a> for &'a <a class="struct" href="struct.Deque.html" title="struct heapless::Deque">Deque</a><T, N></h3><a href="#impl-IntoIterator-1" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#522-529" title="goto source code">[src]</a></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Item-1" class="type trait-impl has-srclink"><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.54.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" class="type">Item</a> = &'a T</h4><a href="#associatedtype.Item-1" class="anchor"></a></div></summary><div class='docblock'><p>The type of the elements being iterated over.</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.into_iter" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.54.0/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter" class="fnname">into_iter</a>(self) -> Self::<a class="type" href="https://doc.rust-lang.org/1.54.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" title="type core::iter::traits::collect::IntoIterator::IntoIter">IntoIter</a></h4><a href="#method.into_iter" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#403-405" title="goto source code">[src]</a></div></summary><div class='docblock'><p>Creates an iterator from a value. <a href="https://doc.rust-lang.org/1.54.0/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter">Read more</a></p>
|
||||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-IntoIterator-1" class="impl has-srclink"><h3 class="code-header in-band">impl<'a, T, const N: usize> <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a> for &'a <a class="struct" href="struct.Deque.html" title="struct heapless::Deque">Deque</a><T, N></h3><a href="#impl-IntoIterator-1" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#521-528" title="goto source code">[src]</a></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Item-1" class="type trait-impl has-srclink"><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.54.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" class="type">Item</a> = &'a T</h4><a href="#associatedtype.Item-1" class="anchor"></a></div></summary><div class='docblock'><p>The type of the elements being iterated over.</p>
|
||||
</div></details><details class="rustdoc-toggle" open><summary><div id="associatedtype.IntoIter-1" class="type trait-impl has-srclink"><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.54.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" class="type">IntoIter</a> = Iter<'a, T, N></h4><a href="#associatedtype.IntoIter-1" class="anchor"></a></div></summary><div class='docblock'><p>Which kind of iterator are we turning this into?</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.into_iter-1" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.54.0/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter" class="fnname">into_iter</a>(self) -> Self::<a class="type" href="https://doc.rust-lang.org/1.54.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" title="type core::iter::traits::collect::IntoIterator::IntoIter">IntoIter</a></h4><a href="#method.into_iter-1" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#526-528" title="goto source code">[src]</a></div></summary><div class='docblock'><p>Creates an iterator from a value. <a href="https://doc.rust-lang.org/1.54.0/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter">Read more</a></p>
|
||||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-IntoIterator-2" class="impl has-srclink"><h3 class="code-header in-band">impl<'a, T, const N: usize> <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a> for &'a mut <a class="struct" href="struct.Deque.html" title="struct heapless::Deque">Deque</a><T, N></h3><a href="#impl-IntoIterator-2" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#531-538" title="goto source code">[src]</a></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Item-2" class="type trait-impl has-srclink"><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.54.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" class="type">Item</a> = &'a mut T</h4><a href="#associatedtype.Item-2" class="anchor"></a></div></summary><div class='docblock'><p>The type of the elements being iterated over.</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.into_iter-1" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.54.0/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter" class="fnname">into_iter</a>(self) -> Self::<a class="type" href="https://doc.rust-lang.org/1.54.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" title="type core::iter::traits::collect::IntoIterator::IntoIter">IntoIter</a></h4><a href="#method.into_iter-1" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#525-527" title="goto source code">[src]</a></div></summary><div class='docblock'><p>Creates an iterator from a value. <a href="https://doc.rust-lang.org/1.54.0/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter">Read more</a></p>
|
||||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-IntoIterator-2" class="impl has-srclink"><h3 class="code-header in-band">impl<'a, T, const N: usize> <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a> for &'a mut <a class="struct" href="struct.Deque.html" title="struct heapless::Deque">Deque</a><T, N></h3><a href="#impl-IntoIterator-2" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#530-537" title="goto source code">[src]</a></div></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Item-2" class="type trait-impl has-srclink"><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.54.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" class="type">Item</a> = &'a mut T</h4><a href="#associatedtype.Item-2" class="anchor"></a></div></summary><div class='docblock'><p>The type of the elements being iterated over.</p>
|
||||
</div></details><details class="rustdoc-toggle" open><summary><div id="associatedtype.IntoIter-2" class="type trait-impl has-srclink"><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.54.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" class="type">IntoIter</a> = IterMut<'a, T, N></h4><a href="#associatedtype.IntoIter-2" class="anchor"></a></div></summary><div class='docblock'><p>Which kind of iterator are we turning this into?</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.into_iter-2" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.54.0/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter" class="fnname">into_iter</a>(self) -> Self::<a class="type" href="https://doc.rust-lang.org/1.54.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" title="type core::iter::traits::collect::IntoIterator::IntoIter">IntoIter</a></h4><a href="#method.into_iter-2" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#535-537" title="goto source code">[src]</a></div></summary><div class='docblock'><p>Creates an iterator from a value. <a href="https://doc.rust-lang.org/1.54.0/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter">Read more</a></p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><div id="method.into_iter-2" class="method trait-impl has-srclink"><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.54.0/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter" class="fnname">into_iter</a>(self) -> Self::<a class="type" href="https://doc.rust-lang.org/1.54.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" title="type core::iter::traits::collect::IntoIterator::IntoIter">IntoIter</a></h4><a href="#method.into_iter-2" class="anchor"></a><a class="srclink" href="../src/heapless/deque.rs.html#534-536" title="goto source code">[src]</a></div></summary><div class='docblock'><p>Creates an iterator from a value. <a href="https://doc.rust-lang.org/1.54.0/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter">Read more</a></p>
|
||||
</div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><div id="impl-Send" class="impl has-srclink"><h3 class="code-header in-band">impl<T, const N: usize> <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.Deque.html" title="struct heapless::Deque">Deque</a><T, N> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></h3><a href="#impl-Send" class="anchor"></a></div><div id="impl-Sync" class="impl has-srclink"><h3 class="code-header in-band">impl<T, const N: usize> <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.Deque.html" title="struct heapless::Deque">Deque</a><T, N> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>, </span></h3><a href="#impl-Sync" class="anchor"></a></div><div id="impl-Unpin" class="impl has-srclink"><h3 class="code-header in-band">impl<T, const N: usize> <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.Deque.html" title="struct heapless::Deque">Deque</a><T, N> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>, </span></h3><a href="#impl-Unpin" class="anchor"></a></div></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-Any" class="impl has-srclink"><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.54.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3><a href="#impl-Any" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/1.54.0/src/core/any.rs.html#131-135" title="goto source code">[src]</a></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.type_id" class="method trait-impl has-srclink"><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.54.0/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.54.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4><a href="#method.type_id" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/1.54.0/src/core/any.rs.html#132" title="goto source code">[src]</a></div></summary><div class='docblock'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.54.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-Borrow%3CT%3E" class="impl has-srclink"><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.54.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3><a href="#impl-Borrow%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/1.54.0/src/core/borrow.rs.html#208-213" title="goto source code">[src]</a></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.borrow" class="method trait-impl has-srclink"><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.54.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> &T</h4><a href="#method.borrow" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/1.54.0/src/core/borrow.rs.html#210" title="goto source code">[src]</a></div></summary><div class='docblock'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.54.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||||
</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-BorrowMut%3CT%3E" class="impl has-srclink"><h3 class="code-header in-band">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/1.54.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></h3><a href="#impl-BorrowMut%3CT%3E" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/1.54.0/src/core/borrow.rs.html#216-220" title="goto source code">[src]</a></div></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><div id="method.borrow_mut" class="method trait-impl has-srclink"><h4 class="code-header">pub fn <a href="https://doc.rust-lang.org/1.54.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> &mut T</h4><a href="#method.borrow_mut" class="anchor"></a><a class="srclink" href="https://doc.rust-lang.org/1.54.0/src/core/borrow.rs.html#217" title="goto source code">[src]</a></div></summary><div class='docblock'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.54.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||||
|
||||
@ -852,7 +852,6 @@
|
||||
<span id="850">850</span>
|
||||
<span id="851">851</span>
|
||||
<span id="852">852</span>
|
||||
<span id="853">853</span>
|
||||
</pre><pre class="rust">
|
||||
<span class="kw">use</span> <span class="ident">core::fmt</span>;
|
||||
<span class="kw">use</span> <span class="ident">core::iter::FusedIterator</span>;
|
||||
@ -1024,22 +1023,21 @@
|
||||
|
||||
<span class="doccomment">/// Returns a pair of mutable slices which contain, in order, the contents of the `Deque`.</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">as_mut_slices</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> (<span class="kw-2">&</span><span class="kw-2">mut</span> [<span class="ident">T</span>], <span class="kw-2">&</span><span class="kw-2">mut</span> [<span class="ident">T</span>]) {
|
||||
<span class="kw">let</span> <span class="ident">ptr</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">buffer</span>.<span class="ident">as_mut_ptr</span>();
|
||||
|
||||
<span class="comment">// NOTE(unsafe) avoid bound checks in the slicing operation</span>
|
||||
<span class="kw">unsafe</span> {
|
||||
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">is_empty</span>() {
|
||||
(<span class="kw-2">&</span><span class="kw-2">mut</span> [], <span class="kw-2">&</span><span class="kw-2">mut</span> [])
|
||||
} <span class="kw">else</span> <span class="kw">if</span> <span class="self">self</span>.<span class="ident">back</span> <span class="op"><</span><span class="op">=</span> <span class="self">self</span>.<span class="ident">front</span> {
|
||||
(
|
||||
<span class="ident">slice::from_raw_parts_mut</span>(
|
||||
<span class="self">self</span>.<span class="ident">buffer</span>.<span class="ident">as_mut_ptr</span>().<span class="ident">add</span>(<span class="self">self</span>.<span class="ident">front</span>) <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">T</span>,
|
||||
<span class="ident">N</span> <span class="op">-</span> <span class="self">self</span>.<span class="ident">front</span>,
|
||||
),
|
||||
<span class="ident">slice::from_raw_parts_mut</span>(<span class="self">self</span>.<span class="ident">buffer</span>.<span class="ident">as_mut_ptr</span>() <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">T</span>, <span class="self">self</span>.<span class="ident">back</span>),
|
||||
<span class="ident">slice::from_raw_parts_mut</span>(<span class="ident">ptr</span>.<span class="ident">add</span>(<span class="self">self</span>.<span class="ident">front</span>) <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">T</span>, <span class="ident">N</span> <span class="op">-</span> <span class="self">self</span>.<span class="ident">front</span>),
|
||||
<span class="ident">slice::from_raw_parts_mut</span>(<span class="ident">ptr</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">T</span>, <span class="self">self</span>.<span class="ident">back</span>),
|
||||
)
|
||||
} <span class="kw">else</span> {
|
||||
(
|
||||
<span class="ident">slice::from_raw_parts_mut</span>(
|
||||
<span class="self">self</span>.<span class="ident">buffer</span>.<span class="ident">as_mut_ptr</span>().<span class="ident">add</span>(<span class="self">self</span>.<span class="ident">front</span>) <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">T</span>,
|
||||
<span class="ident">ptr</span>.<span class="ident">add</span>(<span class="self">self</span>.<span class="ident">front</span>) <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">T</span>,
|
||||
<span class="self">self</span>.<span class="ident">back</span> <span class="op">-</span> <span class="self">self</span>.<span class="ident">front</span>,
|
||||
),
|
||||
<span class="kw-2">&</span><span class="kw-2">mut</span> [],
|
||||
@ -1207,7 +1205,7 @@
|
||||
<span class="kw">let</span> <span class="ident">done</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">is_empty</span>();
|
||||
<span class="ident">IterMut</span> {
|
||||
<span class="ident">_phantom</span>: <span class="ident">PhantomData</span>,
|
||||
<span class="ident">buffer</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="ident">buffer</span>[<span class="number">0</span>] <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">MaybeUninit</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>,
|
||||
<span class="ident">buffer</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="ident">buffer</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="kw">_</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">MaybeUninit</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>,
|
||||
<span class="ident">front</span>: <span class="self">self</span>.<span class="ident">front</span>,
|
||||
<span class="ident">back</span>: <span class="self">self</span>.<span class="ident">back</span>,
|
||||
<span class="ident">done</span>,
|
||||
|
||||
@ -906,6 +906,8 @@
|
||||
<span id="904">904</span>
|
||||
<span id="905">905</span>
|
||||
<span id="906">906</span>
|
||||
<span id="907">907</span>
|
||||
<span id="908">908</span>
|
||||
</pre><pre class="rust">
|
||||
<span class="doccomment">//! Fixed capacity Single Producer Single Consumer (SPSC) queue</span>
|
||||
<span class="doccomment">//!</span>
|
||||
@ -1530,6 +1532,7 @@
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||||
<span class="attribute">#[<span class="ident">cfg_attr</span>(<span class="ident">miri</span>, <span class="ident">ignore</span>)]</span> <span class="comment">// too slow</span>
|
||||
<span class="kw">fn</span> <span class="ident">len</span>() {
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">rb</span>: <span class="ident">Queue</span><span class="op"><</span><span class="ident">i32</span>, <span class="number">3</span><span class="op">></span> <span class="op">=</span> <span class="ident">Queue::new</span>();
|
||||
|
||||
@ -1550,6 +1553,7 @@
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||||
<span class="attribute">#[<span class="ident">cfg_attr</span>(<span class="ident">miri</span>, <span class="ident">ignore</span>)]</span> <span class="comment">// too slow</span>
|
||||
<span class="kw">fn</span> <span class="ident">try_overflow</span>() {
|
||||
<span class="kw">const</span> <span class="ident">N</span>: <span class="ident">usize</span> <span class="op">=</span> <span class="number">23</span>;
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">rb</span>: <span class="ident">Queue</span><span class="op"><</span><span class="ident">i32</span>, <span class="ident">N</span><span class="op">></span> <span class="op">=</span> <span class="ident">Queue::new</span>();
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user