mirror of
https://github.com/rtic-rs/rtic.git
synced 2025-12-21 07:15:32 +01:00
30 lines
No EOL
7 KiB
HTML
30 lines
No EOL
7 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>heapless::deque - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-e56847b5.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="heapless" data-themes="" data-resource-suffix="" data-rustdoc-version="1.91.1 (ed61e7d7e 2025-11-07)" data-channel="1.91.1" data-search-js="search-e256b49e.js" data-stringdex-js="stringdex-c3e638e9.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-6dc2a7f3.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Module deque</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../heapless/index.html">heapless</a><span class="version">0.9.2</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module deque</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#examples" title="Examples">Examples</a></li></ul><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate heapless</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">heapless</a></div><h1>Module <span>deque</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/heapless/deque.rs.html#1-2198">Source</a> </span></div><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 class="doc-anchor" href="#examples">§</a>Examples</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="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.DequeInner.html" title="struct heapless::deque::DequeInner">Deque<wbr>Inner</a></dt><dd>Base struct for <a href="type.Deque.html" title="type heapless::deque::Deque"><code>Deque</code></a> and <a href="type.DequeView.html" title="type heapless::deque::DequeView"><code>DequeView</code></a>, generic over the <a href="../vec/trait.VecStorage.html" title="trait heapless::vec::VecStorage"><code>VecStorage</code></a>.</dd><dt><a class="struct" href="struct.IntoIter.html" title="struct heapless::deque::IntoIter">Into<wbr>Iter</a></dt><dd>An iterator that moves out of a <a href="type.Deque.html" title="type heapless::deque::Deque"><code>Deque</code></a>.</dd><dt><a class="struct" href="struct.Iter.html" title="struct heapless::deque::Iter">Iter</a></dt><dd>Iterator over the contents of a <a href="type.Deque.html" title="type heapless::deque::Deque"><code>Deque</code></a></dd><dt><a class="struct" href="struct.IterMut.html" title="struct heapless::deque::IterMut">IterMut</a></dt><dd>Iterator over the contents of a <a href="type.Deque.html" title="type heapless::deque::Deque"><code>Deque</code></a></dd></dl><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><dl class="item-table"><dt><a class="type" href="type.Deque.html" title="type heapless::deque::Deque">Deque</a></dt><dd>A fixed capacity double-ended queue.</dd><dt><a class="type" href="type.DequeView.html" title="type heapless::deque::DequeView">Deque<wbr>View</a></dt><dd>A double-ended queue with dynamic capacity.</dd></dl></section></div></main></body></html> |