90 lines
No EOL
38 KiB
HTML
90 lines
No EOL
38 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="A fixed capacity double-ended queue."><title>Deque in arduboy_rust::heapless - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-fa3bb1812debf86c.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="arduboy_rust" data-themes="" data-resource-suffix="" data-rustdoc-version="1.75.0-nightly (2bbb61989 2023-10-04)" data-channel="nightly" data-search-js="search-8be46b629f5f14a8.js" data-settings-js="settings-74424d7eec62a23e.js" ><script src="../../static.files/storage-fec3eaa3851e447d.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-c5bd66d33317d69f.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-5d8b3c7633ad77ba.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.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]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="logo-container" href="../../arduboy_rust/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a></nav><nav class="sidebar"><a class="logo-container" href="../../arduboy_rust/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2 class="location"><a href="#">Deque</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.as_mut_slices">as_mut_slices</a></li><li><a href="#method.as_slices">as_slices</a></li><li><a href="#method.back">back</a></li><li><a href="#method.back_mut">back_mut</a></li><li><a href="#method.capacity">capacity</a></li><li><a href="#method.clear">clear</a></li><li><a href="#method.front">front</a></li><li><a href="#method.front_mut">front_mut</a></li><li><a href="#method.is_empty">is_empty</a></li><li><a href="#method.is_full">is_full</a></li><li><a href="#method.iter">iter</a></li><li><a href="#method.iter_mut">iter_mut</a></li><li><a href="#method.len">len</a></li><li><a href="#method.new">new</a></li><li><a href="#method.pop_back">pop_back</a></li><li><a href="#method.pop_back_unchecked">pop_back_unchecked</a></li><li><a href="#method.pop_front">pop_front</a></li><li><a href="#method.pop_front_unchecked">pop_front_unchecked</a></li><li><a href="#method.push_back">push_back</a></li><li><a href="#method.push_back_unchecked">push_back_unchecked</a></li><li><a href="#method.push_front">push_front</a></li><li><a href="#method.push_front_unchecked">push_front_unchecked</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Clone-for-Deque%3CT,+N%3E">Clone</a></li><li><a href="#impl-Debug-for-Deque%3CT,+N%3E">Debug</a></li><li><a href="#impl-Default-for-Deque%3CT,+N%3E">Default</a></li><li><a href="#impl-Drop-for-Deque%3CT,+N%3E">Drop</a></li><li><a href="#impl-IntoIterator-for-%26'a+Deque%3CT,+N%3E">IntoIterator</a></li><li><a href="#impl-IntoIterator-for-%26'a+mut+Deque%3CT,+N%3E">IntoIterator</a></li><li><a href="#impl-IntoIterator-for-Deque%3CT,+N%3E">IntoIterator</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-Deque%3CT,+N%3E">RefUnwindSafe</a></li><li><a href="#impl-Send-for-Deque%3CT,+N%3E">Send</a></li><li><a href="#impl-Sync-for-Deque%3CT,+N%3E">Sync</a></li><li><a href="#impl-Unpin-for-Deque%3CT,+N%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Deque%3CT,+N%3E">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-Deque%3CT,+N%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-Deque%3CT,+N%3E">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-Deque%3CT,+N%3E">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-Deque%3CT,+N%3E">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-Deque%3CT,+N%3E">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-Deque%3CT,+N%3E">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-Deque%3CT,+N%3E">TryInto<U></a></li></ul></section><h2><a href="index.html">In arduboy_rust::heapless</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Struct <a href="../index.html">arduboy_rust</a>::<wbr><a href="index.html">heapless</a>::<wbr><a class="struct" href="#">Deque</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/heapless/deque.rs.html#41">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub struct Deque<T, const N: usize> { /* private fields */ }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A fixed capacity double-ended queue.</p>
|
||
<h2 id="examples"><a href="#examples">Examples</a></h2>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::Deque;
|
||
|
||
<span class="comment">// A deque with a fixed capacity of 8 elements allocated on the stack
|
||
</span><span class="kw">let </span><span class="kw-2">mut </span>deque = Deque::<<span class="kw">_</span>, <span class="number">8</span>>::new();
|
||
|
||
<span class="comment">// You can use it as a good old FIFO queue.
|
||
</span>deque.push_back(<span class="number">1</span>);
|
||
deque.push_back(<span class="number">2</span>);
|
||
<span class="macro">assert_eq!</span>(deque.len(), <span class="number">2</span>);
|
||
|
||
<span class="macro">assert_eq!</span>(deque.pop_front(), <span class="prelude-val">Some</span>(<span class="number">1</span>));
|
||
<span class="macro">assert_eq!</span>(deque.pop_front(), <span class="prelude-val">Some</span>(<span class="number">2</span>));
|
||
<span class="macro">assert_eq!</span>(deque.len(), <span class="number">0</span>);
|
||
|
||
<span class="comment">// Deque is double-ended, you can push and pop from the front and back.
|
||
</span>deque.push_back(<span class="number">1</span>);
|
||
deque.push_front(<span class="number">2</span>);
|
||
deque.push_back(<span class="number">3</span>);
|
||
deque.push_front(<span class="number">4</span>);
|
||
<span class="macro">assert_eq!</span>(deque.pop_front(), <span class="prelude-val">Some</span>(<span class="number">4</span>));
|
||
<span class="macro">assert_eq!</span>(deque.pop_front(), <span class="prelude-val">Some</span>(<span class="number">2</span>));
|
||
<span class="macro">assert_eq!</span>(deque.pop_front(), <span class="prelude-val">Some</span>(<span class="number">1</span>));
|
||
<span class="macro">assert_eq!</span>(deque.pop_front(), <span class="prelude-val">Some</span>(<span class="number">3</span>));
|
||
|
||
<span class="comment">// You can iterate it, yielding all the elements front-to-back.
|
||
</span><span class="kw">for </span>x <span class="kw">in </span><span class="kw-2">&</span>deque {
|
||
<span class="macro">println!</span>(<span class="string">"{}"</span>, x);
|
||
}</code></pre></div>
|
||
</div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Deque%3CT,+N%3E" class="impl"><a class="src rightside" href="../../src/heapless/deque.rs.html#54">source</a><a href="#impl-Deque%3CT,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, const N: usize> <a class="struct" href="struct.Deque.html" title="struct arduboy_rust::heapless::Deque">Deque</a><T, 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/deque.rs.html#70">source</a><h4 class="code-header">pub const fn <a href="#method.new" class="fn">new</a>() -> <a class="struct" href="struct.Deque.html" title="struct arduboy_rust::heapless::Deque">Deque</a><T, N></h4></section></summary><div class="docblock"><p>Constructs a new, empty deque with a fixed capacity of <code>N</code></p>
|
||
<h5 id="examples-1"><a href="#examples-1">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::Deque;
|
||
|
||
<span class="comment">// allocate the deque on the stack
|
||
</span><span class="kw">let </span><span class="kw-2">mut </span>x: Deque<u8, <span class="number">16</span>> = Deque::new();
|
||
|
||
<span class="comment">// allocate the deque in a static variable
|
||
</span><span class="kw">static </span><span class="kw-2">mut </span>X: Deque<u8, <span class="number">16</span>> = Deque::new();</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.capacity" class="method"><a class="src rightside" href="../../src/heapless/deque.rs.html#99">source</a><h4 class="code-header">pub const fn <a href="#method.capacity" class="fn">capacity</a>(&self) -> usize</h4></section></summary><div class="docblock"><p>Returns the maximum number of elements the deque 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/deque.rs.html#104">source</a><h4 class="code-header">pub const fn <a href="#method.len" class="fn">len</a>(&self) -> usize</h4></section></summary><div class="docblock"><p>Returns the number of elements currently in the deque.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.clear" class="method"><a class="src rightside" href="../../src/heapless/deque.rs.html#115">source</a><h4 class="code-header">pub fn <a href="#method.clear" class="fn">clear</a>(&mut self)</h4></section></summary><div class="docblock"><p>Clears the deque, removing all values.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_empty" class="method"><a class="src rightside" href="../../src/heapless/deque.rs.html#134">source</a><h4 class="code-header">pub fn <a href="#method.is_empty" class="fn">is_empty</a>(&self) -> bool</h4></section></summary><div class="docblock"><p>Returns whether the deque 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/deque.rs.html#139">source</a><h4 class="code-header">pub fn <a href="#method.is_full" class="fn">is_full</a>(&self) -> bool</h4></section></summary><div class="docblock"><p>Returns whether the deque is full (i.e. if <code>len() == capacity()</code>.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.as_slices" class="method"><a class="src rightside" href="../../src/heapless/deque.rs.html#144">source</a><h4 class="code-header">pub fn <a href="#method.as_slices" class="fn">as_slices</a>(&self) -> (&[T], &[T])</h4></section></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="toggle method-toggle" open><summary><section id="method.as_mut_slices" class="method"><a class="src rightside" href="../../src/heapless/deque.rs.html#170">source</a><h4 class="code-header">pub fn <a href="#method.as_mut_slices" class="fn">as_mut_slices</a>(&mut self) -> (&mut [T], &mut [T])</h4></section></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="toggle method-toggle" open><summary><section id="method.front" class="method"><a class="src rightside" href="../../src/heapless/deque.rs.html#195">source</a><h4 class="code-header">pub fn <a href="#method.front" class="fn">front</a>(&self) -> Option<&T></h4></section></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="toggle method-toggle" open><summary><section id="method.front_mut" class="method"><a class="src rightside" href="../../src/heapless/deque.rs.html#204">source</a><h4 class="code-header">pub fn <a href="#method.front_mut" class="fn">front_mut</a>(&mut self) -> Option<&mut T></h4></section></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="toggle method-toggle" open><summary><section id="method.back" class="method"><a class="src rightside" href="../../src/heapless/deque.rs.html#213">source</a><h4 class="code-header">pub fn <a href="#method.back" class="fn">back</a>(&self) -> Option<&T></h4></section></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="toggle method-toggle" open><summary><section id="method.back_mut" class="method"><a class="src rightside" href="../../src/heapless/deque.rs.html#223">source</a><h4 class="code-header">pub fn <a href="#method.back_mut" class="fn">back_mut</a>(&mut self) -> Option<&mut T></h4></section></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="toggle method-toggle" open><summary><section id="method.pop_front" class="method"><a class="src rightside" href="../../src/heapless/deque.rs.html#233">source</a><h4 class="code-header">pub fn <a href="#method.pop_front" class="fn">pop_front</a>(&mut self) -> Option<T></h4></section></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="toggle method-toggle" open><summary><section id="method.pop_back" class="method"><a class="src rightside" href="../../src/heapless/deque.rs.html#242">source</a><h4 class="code-header">pub fn <a href="#method.pop_back" class="fn">pop_back</a>(&mut self) -> Option<T></h4></section></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="toggle method-toggle" open><summary><section id="method.push_front" class="method"><a class="src rightside" href="../../src/heapless/deque.rs.html#253">source</a><h4 class="code-header">pub fn <a href="#method.push_front" class="fn">push_front</a>(&mut self, item: T) -> Result<(), T></h4></section></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="toggle method-toggle" open><summary><section id="method.push_back" class="method"><a class="src rightside" href="../../src/heapless/deque.rs.html#265">source</a><h4 class="code-header">pub fn <a href="#method.push_back" class="fn">push_back</a>(&mut self, item: T) -> Result<(), T></h4></section></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="toggle method-toggle" open><summary><section id="method.pop_front_unchecked" class="method"><a class="src rightside" href="../../src/heapless/deque.rs.html#280">source</a><h4 class="code-header">pub unsafe fn <a href="#method.pop_front_unchecked" class="fn">pop_front_unchecked</a>(&mut self) -> T</h4></section></summary><div class="docblock"><p>Removes an item from the front of the deque and returns it, without checking that the deque
|
||
is not empty</p>
|
||
<h5 id="safety"><a href="#safety">Safety</a></h5>
|
||
<p>It’s undefined behavior to call this on an empty deque</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.pop_back_unchecked" class="method"><a class="src rightside" href="../../src/heapless/deque.rs.html#295">source</a><h4 class="code-header">pub unsafe fn <a href="#method.pop_back_unchecked" class="fn">pop_back_unchecked</a>(&mut self) -> T</h4></section></summary><div class="docblock"><p>Removes an item from the back of the deque and returns it, without checking that the deque
|
||
is not empty</p>
|
||
<h5 id="safety-1"><a href="#safety-1">Safety</a></h5>
|
||
<p>It’s undefined behavior to call this on an empty deque</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.push_front_unchecked" class="method"><a class="src rightside" href="../../src/heapless/deque.rs.html#308">source</a><h4 class="code-header">pub unsafe fn <a href="#method.push_front_unchecked" class="fn">push_front_unchecked</a>(&mut self, item: T)</h4></section></summary><div class="docblock"><p>Appends an <code>item</code> to the front of the deque</p>
|
||
<h5 id="safety-2"><a href="#safety-2">Safety</a></h5>
|
||
<p>This assumes the deque is not full.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.push_back_unchecked" class="method"><a class="src rightside" href="../../src/heapless/deque.rs.html#326">source</a><h4 class="code-header">pub unsafe fn <a href="#method.push_back_unchecked" class="fn">push_back_unchecked</a>(&mut self, item: T)</h4></section></summary><div class="docblock"><p>Appends an <code>item</code> to the back of the deque</p>
|
||
<h5 id="safety-3"><a href="#safety-3">Safety</a></h5>
|
||
<p>This assumes the deque is not full.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.iter" class="method"><a class="src rightside" href="../../src/heapless/deque.rs.html#339">source</a><h4 class="code-header">pub fn <a href="#method.iter" class="fn">iter</a>(&self) -> Iter<'_, T, N></h4></section></summary><div class="docblock"><p>Returns an iterator over the deque.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.iter_mut" class="method"><a class="src rightside" href="../../src/heapless/deque.rs.html#351">source</a><h4 class="code-header">pub fn <a href="#method.iter_mut" class="fn">iter_mut</a>(&mut self) -> IterMut<'_, T, N></h4></section></summary><div class="docblock"><p>Returns an iterator that allows modifying each value.</p>
|
||
</div></details></div></details></div><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="toggle implementors-toggle" open><summary><section id="impl-Clone-for-Deque%3CT,+N%3E" class="impl"><a class="src rightside" href="../../src/heapless/deque.rs.html#541">source</a><a href="#impl-Clone-for-Deque%3CT,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, const N: usize> Clone for <a class="struct" href="struct.Deque.html" title="struct arduboy_rust::heapless::Deque">Deque</a><T, N><span class="where fmt-newline">where
|
||
T: Clone,</span></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl"><a class="src rightside" href="../../src/heapless/deque.rs.html#545">source</a><a href="#method.clone" class="anchor">§</a><h4 class="code-header">fn <a class="fn">clone</a>(&self) -> <a class="struct" href="struct.Deque.html" title="struct arduboy_rust::heapless::Deque">Deque</a><T, N></h4></section></summary><div class='docblock'>Returns a copy of the value. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl"><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><a href="#method.clone_from" class="anchor">§</a><h4 class="code-header">fn <a class="fn">clone_from</a>(&mut self, source: &Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a>Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-Deque%3CT,+N%3E" class="impl"><a class="src rightside" href="../../src/heapless/deque.rs.html#379">source</a><a href="#impl-Debug-for-Deque%3CT,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, const N: usize> Debug for <a class="struct" href="struct.Deque.html" title="struct arduboy_rust::heapless::Deque">Deque</a><T, N><span class="where fmt-newline">where
|
||
T: Debug,</span></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/deque.rs.html#380">source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a class="fn">fmt</a>(&self, f: &mut Formatter<'_>) -> Result<(), Error></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a>Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Default-for-Deque%3CT,+N%3E" class="impl"><a class="src rightside" href="../../src/heapless/deque.rs.html#365">source</a><a href="#impl-Default-for-Deque%3CT,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, const N: usize> Default for <a class="struct" href="struct.Deque.html" title="struct arduboy_rust::heapless::Deque">Deque</a><T, N></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.default" class="method trait-impl"><a class="src rightside" href="../../src/heapless/deque.rs.html#366">source</a><a href="#method.default" class="anchor">§</a><h4 class="code-header">fn <a class="fn">default</a>() -> <a class="struct" href="struct.Deque.html" title="struct arduboy_rust::heapless::Deque">Deque</a><T, N></h4></section></summary><div class='docblock'>Returns the “default value” for a type. <a>Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Drop-for-Deque%3CT,+N%3E" class="impl"><a class="src rightside" href="../../src/heapless/deque.rs.html#371">source</a><a href="#impl-Drop-for-Deque%3CT,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, const N: usize> Drop for <a class="struct" href="struct.Deque.html" title="struct arduboy_rust::heapless::Deque">Deque</a><T, N></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/deque.rs.html#372">source</a><a href="#method.drop" class="anchor">§</a><h4 class="code-header">fn <a class="fn">drop</a>(&mut self)</h4></section></summary><div class='docblock'>Executes the destructor for this type. <a>Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-IntoIterator-for-%26'a+Deque%3CT,+N%3E" class="impl"><a class="src rightside" href="../../src/heapless/deque.rs.html#523">source</a><a href="#impl-IntoIterator-for-%26'a+Deque%3CT,+N%3E" class="anchor">§</a><h3 class="code-header">impl<'a, T, const N: usize> IntoIterator for &'a <a class="struct" href="struct.Deque.html" title="struct arduboy_rust::heapless::Deque">Deque</a><T, N></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Item-1" class="associatedtype trait-impl"><a href="#associatedtype.Item-1" class="anchor">§</a><h4 class="code-header">type <a class="associatedtype">Item</a> = &'a T</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 href="#associatedtype.IntoIter-1" class="anchor">§</a><h4 class="code-header">type <a class="associatedtype">IntoIter</a> = Iter<'a, T, N></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/deque.rs.html#527">source</a><a href="#method.into_iter-1" class="anchor">§</a><h4 class="code-header">fn <a class="fn">into_iter</a>(self) -> <&'a <a class="struct" href="struct.Deque.html" title="struct arduboy_rust::heapless::Deque">Deque</a><T, N> as IntoIterator>::IntoIter</h4></section></summary><div class='docblock'>Creates an iterator from a value. <a>Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-IntoIterator-for-%26'a+mut+Deque%3CT,+N%3E" class="impl"><a class="src rightside" href="../../src/heapless/deque.rs.html#532">source</a><a href="#impl-IntoIterator-for-%26'a+mut+Deque%3CT,+N%3E" class="anchor">§</a><h3 class="code-header">impl<'a, T, const N: usize> IntoIterator for &'a mut <a class="struct" href="struct.Deque.html" title="struct arduboy_rust::heapless::Deque">Deque</a><T, N></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Item" class="associatedtype trait-impl"><a href="#associatedtype.Item" class="anchor">§</a><h4 class="code-header">type <a class="associatedtype">Item</a> = &'a mut T</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 href="#associatedtype.IntoIter" class="anchor">§</a><h4 class="code-header">type <a class="associatedtype">IntoIter</a> = IterMut<'a, T, N></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/deque.rs.html#536">source</a><a href="#method.into_iter" class="anchor">§</a><h4 class="code-header">fn <a class="fn">into_iter</a>(self) -> <&'a mut <a class="struct" href="struct.Deque.html" title="struct arduboy_rust::heapless::Deque">Deque</a><T, N> as IntoIterator>::IntoIter</h4></section></summary><div class='docblock'>Creates an iterator from a value. <a>Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-IntoIterator-for-Deque%3CT,+N%3E" class="impl"><a class="src rightside" href="../../src/heapless/deque.rs.html#401">source</a><a href="#impl-IntoIterator-for-Deque%3CT,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, const N: usize> IntoIterator for <a class="struct" href="struct.Deque.html" title="struct arduboy_rust::heapless::Deque">Deque</a><T, N></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Item-2" class="associatedtype trait-impl"><a href="#associatedtype.Item-2" class="anchor">§</a><h4 class="code-header">type <a class="associatedtype">Item</a> = T</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-2" class="associatedtype trait-impl"><a href="#associatedtype.IntoIter-2" class="anchor">§</a><h4 class="code-header">type <a class="associatedtype">IntoIter</a> = IntoIter<T, N></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-2" class="method trait-impl"><a class="src rightside" href="../../src/heapless/deque.rs.html#405">source</a><a href="#method.into_iter-2" class="anchor">§</a><h4 class="code-header">fn <a class="fn">into_iter</a>(self) -> <<a class="struct" href="struct.Deque.html" title="struct arduboy_rust::heapless::Deque">Deque</a><T, N> as IntoIterator>::IntoIter</h4></section></summary><div class='docblock'>Creates an iterator from a value. <a>Read more</a></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"><section id="impl-RefUnwindSafe-for-Deque%3CT,+N%3E" class="impl"><a href="#impl-RefUnwindSafe-for-Deque%3CT,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, const N: usize> RefUnwindSafe for <a class="struct" href="struct.Deque.html" title="struct arduboy_rust::heapless::Deque">Deque</a><T, N><span class="where fmt-newline">where
|
||
T: RefUnwindSafe,</span></h3></section><section id="impl-Send-for-Deque%3CT,+N%3E" class="impl"><a href="#impl-Send-for-Deque%3CT,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, const N: usize> Send for <a class="struct" href="struct.Deque.html" title="struct arduboy_rust::heapless::Deque">Deque</a><T, N><span class="where fmt-newline">where
|
||
T: Send,</span></h3></section><section id="impl-Sync-for-Deque%3CT,+N%3E" class="impl"><a href="#impl-Sync-for-Deque%3CT,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, const N: usize> Sync for <a class="struct" href="struct.Deque.html" title="struct arduboy_rust::heapless::Deque">Deque</a><T, N><span class="where fmt-newline">where
|
||
T: Sync,</span></h3></section><section id="impl-Unpin-for-Deque%3CT,+N%3E" class="impl"><a href="#impl-Unpin-for-Deque%3CT,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, const N: usize> Unpin for <a class="struct" href="struct.Deque.html" title="struct arduboy_rust::heapless::Deque">Deque</a><T, N><span class="where fmt-newline">where
|
||
T: Unpin,</span></h3></section><section id="impl-UnwindSafe-for-Deque%3CT,+N%3E" class="impl"><a href="#impl-UnwindSafe-for-Deque%3CT,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, const N: usize> UnwindSafe for <a class="struct" href="struct.Deque.html" title="struct arduboy_rust::heapless::Deque">Deque</a><T, N><span class="where fmt-newline">where
|
||
T: UnwindSafe,</span></h3></section></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="toggle implementors-toggle"><summary><section id="impl-Any-for-Deque%3CT,+N%3E" class="impl"><a href="#impl-Any-for-Deque%3CT,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T> Any for T<span class="where fmt-newline">where
|
||
T: 'static + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a class="fn">type_id</a>(&self) -> TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-Deque%3CT,+N%3E" class="impl"><a href="#impl-Borrow%3CT%3E-for-Deque%3CT,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T> Borrow<T> for T<span class="where fmt-newline">where
|
||
T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a class="fn">borrow</a>(&self) -> &T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-Deque%3CT,+N%3E" class="impl"><a href="#impl-BorrowMut%3CT%3E-for-Deque%3CT,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T> BorrowMut<T> for T<span class="where fmt-newline">where
|
||
T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a class="fn">borrow_mut</a>(&mut self) -> &mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-Deque%3CT,+N%3E" class="impl"><a href="#impl-From%3CT%3E-for-Deque%3CT,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T> From<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 href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a 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-Deque%3CT,+N%3E" class="impl"><a href="#impl-Into%3CU%3E-for-Deque%3CT,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, U> Into<U> for T<span class="where fmt-newline">where
|
||
U: From<T>,</span></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a 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>[From]<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-Deque%3CT,+N%3E" class="impl"><a href="#impl-TryFrom%3CU%3E-for-Deque%3CT,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, U> TryFrom<U> for T<span class="where fmt-newline">where
|
||
U: Into<T>,</span></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a class="associatedtype">Error</a> = Infallible</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 href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a class="fn">try_from</a>(value: U) -> Result<T, <T as TryFrom<U>>::Error></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-Deque%3CT,+N%3E" class="impl"><a href="#impl-TryInto%3CU%3E-for-Deque%3CT,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, U> TryInto<U> for T<span class="where fmt-newline">where
|
||
U: TryFrom<T>,</span></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a class="associatedtype">Error</a> = <U as TryFrom<T>>::Error</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 href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a class="fn">try_into</a>(self) -> Result<U, <U as TryFrom<T>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html> |