197 lines
No EOL
38 KiB
HTML
197 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 priority queue implemented with a binary heap."><title>BinaryHeap 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-cb6f1f67f1bcd037.css" id="mainThemeStyle"><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.73.0-nightly (500647fd8 2023-07-27)" data-channel="nightly" data-search-js="search-6dfdfced5eff6596.js" data-settings-js="settings-de11bff964e9d4e5.js" data-settings-css="settings-8c76f75bfb6bd192.css" data-theme-light-css="light-6d2c9675f3d09c26.css" data-theme-dark-css="dark-45ceb8f2e522f4d1.css" data-theme-ayu-css="ayu-fd19013d6ce078bf.css" ><script src="../../static.files/storage-db41da1a38ea3cb8.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-0795b7d26be81095.js"></script><noscript><link rel="stylesheet" media="(prefers-color-scheme:light)" href="../../static.files/light-6d2c9675f3d09c26.css"><link rel="stylesheet" media="(prefers-color-scheme:dark)" href="../../static.files/dark-45ceb8f2e522f4d1.css"><link rel="stylesheet" href="../../static.files/noscript-cffde32267a19fd6.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><h2></h2></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="#">BinaryHeap</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.capacity">capacity</a></li><li><a href="#method.clear">clear</a></li><li><a href="#method.into_vec">into_vec</a></li><li><a href="#method.is_empty">is_empty</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.peek">peek</a></li><li><a href="#method.peek_mut">peek_mut</a></li><li><a href="#method.pop">pop</a></li><li><a href="#method.pop_unchecked">pop_unchecked</a></li><li><a href="#method.push">push</a></li><li><a href="#method.push_unchecked">push_unchecked</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Clone-for-BinaryHeap%3CT,+K,+N%3E">Clone</a></li><li><a href="#impl-Debug-for-BinaryHeap%3CT,+K,+N%3E">Debug</a></li><li><a href="#impl-Default-for-BinaryHeap%3CT,+K,+N%3E">Default</a></li><li><a href="#impl-IntoIterator-for-%26'a+BinaryHeap%3CT,+K,+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-BinaryHeap%3CT,+K,+N%3E">RefUnwindSafe</a></li><li><a href="#impl-Send-for-BinaryHeap%3CT,+K,+N%3E">Send</a></li><li><a href="#impl-Sync-for-BinaryHeap%3CT,+K,+N%3E">Sync</a></li><li><a href="#impl-Unpin-for-BinaryHeap%3CT,+K,+N%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-BinaryHeap%3CT,+K,+N%3E">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-BinaryHeap%3CT,+K,+N%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-BinaryHeap%3CT,+K,+N%3E">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-BinaryHeap%3CT,+K,+N%3E">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-BinaryHeap%3CT,+K,+N%3E">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-BinaryHeap%3CT,+K,+N%3E">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-BinaryHeap%3CT,+K,+N%3E">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-BinaryHeap%3CT,+K,+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="#">BinaryHeap</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/binary_heap.rs.html#101">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub struct BinaryHeap<T, K, 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 priority queue implemented with a binary heap.</p>
|
||
<p>This can be either a min-heap or a max-heap.</p>
|
||
<p>It is a logic error for an item to be modified in such a way that the item’s ordering relative
|
||
to any other item, as determined by the <code>Ord</code> trait, changes while it is in the heap. This is
|
||
normally only possible through <code>Cell</code>, <code>RefCell</code>, global state, I/O, or unsafe code.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::binary_heap::{BinaryHeap, Max};
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>heap: BinaryHeap<<span class="kw">_</span>, Max, <span class="number">8</span>> = BinaryHeap::new();
|
||
|
||
<span class="comment">// We can use peek to look at the next item in the heap. In this case,
|
||
// there's no items in there yet so we get None.
|
||
</span><span class="macro">assert_eq!</span>(heap.peek(), <span class="prelude-val">None</span>);
|
||
|
||
<span class="comment">// Let's add some scores...
|
||
</span>heap.push(<span class="number">1</span>).unwrap();
|
||
heap.push(<span class="number">5</span>).unwrap();
|
||
heap.push(<span class="number">2</span>).unwrap();
|
||
|
||
<span class="comment">// Now peek shows the most important item in the heap.
|
||
</span><span class="macro">assert_eq!</span>(heap.peek(), <span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="number">5</span>));
|
||
|
||
<span class="comment">// We can check the length of a heap.
|
||
</span><span class="macro">assert_eq!</span>(heap.len(), <span class="number">3</span>);
|
||
|
||
<span class="comment">// We can iterate over the items in the heap, although they are returned in
|
||
// a random order.
|
||
</span><span class="kw">for </span>x <span class="kw">in </span><span class="kw-2">&</span>heap {
|
||
<span class="macro">println!</span>(<span class="string">"{}"</span>, x);
|
||
}
|
||
|
||
<span class="comment">// If we instead pop these scores, they should come back in order.
|
||
</span><span class="macro">assert_eq!</span>(heap.pop(), <span class="prelude-val">Some</span>(<span class="number">5</span>));
|
||
<span class="macro">assert_eq!</span>(heap.pop(), <span class="prelude-val">Some</span>(<span class="number">2</span>));
|
||
<span class="macro">assert_eq!</span>(heap.pop(), <span class="prelude-val">Some</span>(<span class="number">1</span>));
|
||
<span class="macro">assert_eq!</span>(heap.pop(), <span class="prelude-val">None</span>);
|
||
|
||
<span class="comment">// We can clear the heap of any remaining items.
|
||
</span>heap.clear();
|
||
|
||
<span class="comment">// The heap should now be empty.
|
||
</span><span class="macro">assert!</span>(heap.is_empty())</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-BinaryHeap%3CT,+K,+N%3E" class="impl"><a class="src rightside" href="../../src/heapless/binary_heap.rs.html#106">source</a><a href="#impl-BinaryHeap%3CT,+K,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, K, const N: usize> <a class="struct" href="struct.BinaryHeap.html" title="struct arduboy_rust::heapless::BinaryHeap">BinaryHeap</a><T, K, 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/binary_heap.rs.html#120">source</a><h4 class="code-header">pub const fn <a href="#method.new" class="fn">new</a>() -> <a class="struct" href="struct.BinaryHeap.html" title="struct arduboy_rust::heapless::BinaryHeap">BinaryHeap</a><T, K, N></h4></section></summary><div class="docblock"><p>Creates an empty BinaryHeap as a $K-heap.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::binary_heap::{BinaryHeap, Max};
|
||
|
||
<span class="comment">// allocate the binary heap on the stack
|
||
</span><span class="kw">let </span><span class="kw-2">mut </span>heap: BinaryHeap<<span class="kw">_</span>, Max, <span class="number">8</span>> = BinaryHeap::new();
|
||
heap.push(<span class="number">4</span>).unwrap();
|
||
|
||
<span class="comment">// allocate the binary heap in a static variable
|
||
</span><span class="kw">static </span><span class="kw-2">mut </span>HEAP: BinaryHeap<i32, Max, <span class="number">8</span>> = BinaryHeap::new();</code></pre></div>
|
||
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-BinaryHeap%3CT,+K,+N%3E-1" class="impl"><a class="src rightside" href="../../src/heapless/binary_heap.rs.html#128">source</a><a href="#impl-BinaryHeap%3CT,+K,+N%3E-1" class="anchor">§</a><h3 class="code-header">impl<T, K, const N: usize> <a class="struct" href="struct.BinaryHeap.html" title="struct arduboy_rust::heapless::BinaryHeap">BinaryHeap</a><T, K, N><span class="where fmt-newline">where
|
||
T: Ord,
|
||
K: <a class="trait" href="binary_heap/trait.Kind.html" title="trait arduboy_rust::heapless::binary_heap::Kind">Kind</a>,</span></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.capacity" class="method"><a class="src rightside" href="../../src/heapless/binary_heap.rs.html#135">source</a><h4 class="code-header">pub fn <a href="#method.capacity" class="fn">capacity</a>(&self) -> usize</h4></section></summary><div class="docblock"><p>Returns the capacity of the binary heap.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.clear" class="method"><a class="src rightside" href="../../src/heapless/binary_heap.rs.html#154">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>Drops all items from the binary heap.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::binary_heap::{BinaryHeap, Max};
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>heap: BinaryHeap<<span class="kw">_</span>, Max, <span class="number">8</span>> = BinaryHeap::new();
|
||
heap.push(<span class="number">1</span>).unwrap();
|
||
heap.push(<span class="number">3</span>).unwrap();
|
||
|
||
<span class="macro">assert!</span>(!heap.is_empty());
|
||
|
||
heap.clear();
|
||
|
||
<span class="macro">assert!</span>(heap.is_empty());</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.len" class="method"><a class="src rightside" href="../../src/heapless/binary_heap.rs.html#169">source</a><h4 class="code-header">pub fn <a href="#method.len" class="fn">len</a>(&self) -> usize</h4></section></summary><div class="docblock"><p>Returns the length of the binary heap.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::binary_heap::{BinaryHeap, Max};
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>heap: BinaryHeap<<span class="kw">_</span>, Max, <span class="number">8</span>> = BinaryHeap::new();
|
||
heap.push(<span class="number">1</span>).unwrap();
|
||
heap.push(<span class="number">3</span>).unwrap();
|
||
|
||
<span class="macro">assert_eq!</span>(heap.len(), <span class="number">2</span>);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_empty" class="method"><a class="src rightside" href="../../src/heapless/binary_heap.rs.html#188">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>Checks if the binary heap is empty.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::binary_heap::{BinaryHeap, Max};
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>heap: BinaryHeap<<span class="kw">_</span>, Max, <span class="number">8</span>> = BinaryHeap::new();
|
||
|
||
<span class="macro">assert!</span>(heap.is_empty());
|
||
|
||
heap.push(<span class="number">3</span>).unwrap();
|
||
heap.push(<span class="number">5</span>).unwrap();
|
||
heap.push(<span class="number">1</span>).unwrap();
|
||
|
||
<span class="macro">assert!</span>(!heap.is_empty());</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.iter" class="method"><a class="src rightside" href="../../src/heapless/binary_heap.rs.html#209">source</a><h4 class="code-header">pub fn <a href="#method.iter" class="fn">iter</a>(&self) -> Iter<'_, T></h4></section></summary><div class="docblock"><p>Returns an iterator visiting all values in the underlying vector, in arbitrary order.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::binary_heap::{BinaryHeap, Max};
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>heap: BinaryHeap<<span class="kw">_</span>, Max, <span class="number">8</span>> = BinaryHeap::new();
|
||
heap.push(<span class="number">1</span>).unwrap();
|
||
heap.push(<span class="number">2</span>).unwrap();
|
||
heap.push(<span class="number">3</span>).unwrap();
|
||
heap.push(<span class="number">4</span>).unwrap();
|
||
|
||
<span class="comment">// Print 1, 2, 3, 4 in arbitrary order
|
||
</span><span class="kw">for </span>x <span class="kw">in </span>heap.iter() {
|
||
<span class="macro">println!</span>(<span class="string">"{}"</span>, x);
|
||
|
||
}</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.iter_mut" class="method"><a class="src rightside" href="../../src/heapless/binary_heap.rs.html#217">source</a><h4 class="code-header">pub fn <a href="#method.iter_mut" class="fn">iter_mut</a>(&mut self) -> IterMut<'_, T></h4></section></summary><div class="docblock"><p>Returns a mutable iterator visiting all values in the underlying vector, in arbitrary order.</p>
|
||
<p><strong>WARNING</strong> Mutating the items in the binary heap can leave the heap in an inconsistent
|
||
state.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.peek" class="method"><a class="src rightside" href="../../src/heapless/binary_heap.rs.html#235">source</a><h4 class="code-header">pub fn <a href="#method.peek" class="fn">peek</a>(&self) -> Option<&T></h4></section></summary><div class="docblock"><p>Returns the <em>top</em> (greatest if max-heap, smallest if min-heap) item in the binary heap, or
|
||
None if it is empty.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::binary_heap::{BinaryHeap, Max};
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>heap: BinaryHeap<<span class="kw">_</span>, Max, <span class="number">8</span>> = BinaryHeap::new();
|
||
<span class="macro">assert_eq!</span>(heap.peek(), <span class="prelude-val">None</span>);
|
||
|
||
heap.push(<span class="number">1</span>).unwrap();
|
||
heap.push(<span class="number">5</span>).unwrap();
|
||
heap.push(<span class="number">2</span>).unwrap();
|
||
<span class="macro">assert_eq!</span>(heap.peek(), <span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="number">5</span>));</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.peek_mut" class="method"><a class="src rightside" href="../../src/heapless/binary_heap.rs.html#265">source</a><h4 class="code-header">pub fn <a href="#method.peek_mut" class="fn">peek_mut</a>(&mut self) -> Option<<a class="struct" href="binary_heap/struct.PeekMut.html" title="struct arduboy_rust::heapless::binary_heap::PeekMut">PeekMut</a><'_, T, K, N>></h4></section></summary><div class="docblock"><p>Returns a mutable reference to the greatest item in the binary heap, or
|
||
<code>None</code> if it is empty.</p>
|
||
<p>Note: If the <code>PeekMut</code> value is leaked, the heap may be in an
|
||
inconsistent state.</p>
|
||
<h5 id="examples"><a href="#examples">Examples</a></h5>
|
||
<p>Basic usage:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::binary_heap::{BinaryHeap, Max};
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>heap: BinaryHeap<<span class="kw">_</span>, Max, <span class="number">8</span>> = BinaryHeap::new();
|
||
<span class="macro">assert!</span>(heap.peek_mut().is_none());
|
||
|
||
heap.push(<span class="number">1</span>);
|
||
heap.push(<span class="number">5</span>);
|
||
heap.push(<span class="number">2</span>);
|
||
{
|
||
<span class="kw">let </span><span class="kw-2">mut </span>val = heap.peek_mut().unwrap();
|
||
<span class="kw-2">*</span>val = <span class="number">0</span>;
|
||
}
|
||
|
||
<span class="macro">assert_eq!</span>(heap.peek(), <span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="number">2</span>));</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.pop" class="method"><a class="src rightside" href="../../src/heapless/binary_heap.rs.html#290">source</a><h4 class="code-header">pub fn <a href="#method.pop" class="fn">pop</a>(&mut self) -> Option<T></h4></section></summary><div class="docblock"><p>Removes the <em>top</em> (greatest if max-heap, smallest if min-heap) item from the binary heap and
|
||
returns it, or None if it is empty.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::binary_heap::{BinaryHeap, Max};
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>heap: BinaryHeap<<span class="kw">_</span>, Max, <span class="number">8</span>> = BinaryHeap::new();
|
||
heap.push(<span class="number">1</span>).unwrap();
|
||
heap.push(<span class="number">3</span>).unwrap();
|
||
|
||
<span class="macro">assert_eq!</span>(heap.pop(), <span class="prelude-val">Some</span>(<span class="number">3</span>));
|
||
<span class="macro">assert_eq!</span>(heap.pop(), <span class="prelude-val">Some</span>(<span class="number">1</span>));
|
||
<span class="macro">assert_eq!</span>(heap.pop(), <span class="prelude-val">None</span>);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.pop_unchecked" class="method"><a class="src rightside" href="../../src/heapless/binary_heap.rs.html#300">source</a><h4 class="code-header">pub unsafe fn <a href="#method.pop_unchecked" class="fn">pop_unchecked</a>(&mut self) -> T</h4></section></summary><div class="docblock"><p>Removes the <em>top</em> (greatest if max-heap, smallest if min-heap) item from the binary heap and
|
||
returns it, without checking if the binary heap is empty.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.push" class="method"><a class="src rightside" href="../../src/heapless/binary_heap.rs.html#323">source</a><h4 class="code-header">pub fn <a href="#method.push" class="fn">push</a>(&mut self, item: T) -> Result<(), T></h4></section></summary><div class="docblock"><p>Pushes an item onto the binary heap.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::binary_heap::{BinaryHeap, Max};
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>heap: BinaryHeap<<span class="kw">_</span>, Max, <span class="number">8</span>> = BinaryHeap::new();
|
||
heap.push(<span class="number">3</span>).unwrap();
|
||
heap.push(<span class="number">5</span>).unwrap();
|
||
heap.push(<span class="number">1</span>).unwrap();
|
||
|
||
<span class="macro">assert_eq!</span>(heap.len(), <span class="number">3</span>);
|
||
<span class="macro">assert_eq!</span>(heap.peek(), <span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="number">5</span>));</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.push_unchecked" class="method"><a class="src rightside" href="../../src/heapless/binary_heap.rs.html#333">source</a><h4 class="code-header">pub unsafe fn <a href="#method.push_unchecked" class="fn">push_unchecked</a>(&mut self, item: T)</h4></section></summary><div class="docblock"><p>Pushes an item onto the binary heap without first checking if it’s full.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.into_vec" class="method"><a class="src rightside" href="../../src/heapless/binary_heap.rs.html#340">source</a><h4 class="code-header">pub fn <a href="#method.into_vec" class="fn">into_vec</a>(self) -> <a class="struct" href="struct.Vec.html" title="struct arduboy_rust::heapless::Vec">Vec</a><T, N></h4></section></summary><div class="docblock"><p>Returns the underlying <code>Vec<T,N></code>. Order is arbitrary and time is O(1).</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-BinaryHeap%3CT,+K,+N%3E" class="impl"><a class="src rightside" href="../../src/heapless/binary_heap.rs.html#532">source</a><a href="#impl-Clone-for-BinaryHeap%3CT,+K,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, K, const N: usize> Clone for <a class="struct" href="struct.BinaryHeap.html" title="struct arduboy_rust::heapless::BinaryHeap">BinaryHeap</a><T, K, N><span class="where fmt-newline">where
|
||
K: <a class="trait" href="binary_heap/trait.Kind.html" title="trait arduboy_rust::heapless::binary_heap::Kind">Kind</a>,
|
||
T: Ord + 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/binary_heap.rs.html#537">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.BinaryHeap.html" title="struct arduboy_rust::heapless::BinaryHeap">BinaryHeap</a><T, K, 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-BinaryHeap%3CT,+K,+N%3E" class="impl"><a class="src rightside" href="../../src/heapless/binary_heap.rs.html#545">source</a><a href="#impl-Debug-for-BinaryHeap%3CT,+K,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, K, const N: usize> Debug for <a class="struct" href="struct.BinaryHeap.html" title="struct arduboy_rust::heapless::BinaryHeap">BinaryHeap</a><T, K, N><span class="where fmt-newline">where
|
||
K: <a class="trait" href="binary_heap/trait.Kind.html" title="trait arduboy_rust::heapless::binary_heap::Kind">Kind</a>,
|
||
T: Ord + 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/binary_heap.rs.html#550">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-BinaryHeap%3CT,+K,+N%3E" class="impl"><a class="src rightside" href="../../src/heapless/binary_heap.rs.html#522">source</a><a href="#impl-Default-for-BinaryHeap%3CT,+K,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, K, const N: usize> Default for <a class="struct" href="struct.BinaryHeap.html" title="struct arduboy_rust::heapless::BinaryHeap">BinaryHeap</a><T, K, N><span class="where fmt-newline">where
|
||
T: Ord,
|
||
K: <a class="trait" href="binary_heap/trait.Kind.html" title="trait arduboy_rust::heapless::binary_heap::Kind">Kind</a>,</span></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/binary_heap.rs.html#527">source</a><a href="#method.default" class="anchor">§</a><h4 class="code-header">fn <a class="fn">default</a>() -> <a class="struct" href="struct.BinaryHeap.html" title="struct arduboy_rust::heapless::BinaryHeap">BinaryHeap</a><T, K, 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-IntoIterator-for-%26'a+BinaryHeap%3CT,+K,+N%3E" class="impl"><a class="src rightside" href="../../src/heapless/binary_heap.rs.html#555">source</a><a href="#impl-IntoIterator-for-%26'a+BinaryHeap%3CT,+K,+N%3E" class="anchor">§</a><h3 class="code-header">impl<'a, T, K, const N: usize> IntoIterator for &'a <a class="struct" href="struct.BinaryHeap.html" title="struct arduboy_rust::heapless::BinaryHeap">BinaryHeap</a><T, K, N><span class="where fmt-newline">where
|
||
K: <a class="trait" href="binary_heap/trait.Kind.html" title="trait arduboy_rust::heapless::binary_heap::Kind">Kind</a>,
|
||
T: Ord,</span></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 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> = Iter<'a, T></h4></section></summary><div class='docblock'>Which kind of iterator are we turning this into?</div></details><details class="toggle method-toggle" open><summary><section id="method.into_iter" class="method trait-impl"><a class="src rightside" href="../../src/heapless/binary_heap.rs.html#563">source</a><a href="#method.into_iter" class="anchor">§</a><h4 class="code-header">fn <a class="fn">into_iter</a>(self) -> <&'a <a class="struct" href="struct.BinaryHeap.html" title="struct arduboy_rust::heapless::BinaryHeap">BinaryHeap</a><T, K, 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-BinaryHeap%3CT,+K,+N%3E" class="impl"><a href="#impl-RefUnwindSafe-for-BinaryHeap%3CT,+K,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, K, const N: usize> RefUnwindSafe for <a class="struct" href="struct.BinaryHeap.html" title="struct arduboy_rust::heapless::BinaryHeap">BinaryHeap</a><T, K, N><span class="where fmt-newline">where
|
||
K: RefUnwindSafe,
|
||
T: RefUnwindSafe,</span></h3></section><section id="impl-Send-for-BinaryHeap%3CT,+K,+N%3E" class="impl"><a href="#impl-Send-for-BinaryHeap%3CT,+K,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, K, const N: usize> Send for <a class="struct" href="struct.BinaryHeap.html" title="struct arduboy_rust::heapless::BinaryHeap">BinaryHeap</a><T, K, N><span class="where fmt-newline">where
|
||
K: Send,
|
||
T: Send,</span></h3></section><section id="impl-Sync-for-BinaryHeap%3CT,+K,+N%3E" class="impl"><a href="#impl-Sync-for-BinaryHeap%3CT,+K,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, K, const N: usize> Sync for <a class="struct" href="struct.BinaryHeap.html" title="struct arduboy_rust::heapless::BinaryHeap">BinaryHeap</a><T, K, N><span class="where fmt-newline">where
|
||
K: Sync,
|
||
T: Sync,</span></h3></section><section id="impl-Unpin-for-BinaryHeap%3CT,+K,+N%3E" class="impl"><a href="#impl-Unpin-for-BinaryHeap%3CT,+K,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, K, const N: usize> Unpin for <a class="struct" href="struct.BinaryHeap.html" title="struct arduboy_rust::heapless::BinaryHeap">BinaryHeap</a><T, K, N><span class="where fmt-newline">where
|
||
K: Unpin,
|
||
T: Unpin,</span></h3></section><section id="impl-UnwindSafe-for-BinaryHeap%3CT,+K,+N%3E" class="impl"><a href="#impl-UnwindSafe-for-BinaryHeap%3CT,+K,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, K, const N: usize> UnwindSafe for <a class="struct" href="struct.BinaryHeap.html" title="struct arduboy_rust::heapless::BinaryHeap">BinaryHeap</a><T, K, N><span class="where fmt-newline">where
|
||
K: UnwindSafe,
|
||
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-BinaryHeap%3CT,+K,+N%3E" class="impl"><a href="#impl-Any-for-BinaryHeap%3CT,+K,+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-BinaryHeap%3CT,+K,+N%3E" class="impl"><a href="#impl-Borrow%3CT%3E-for-BinaryHeap%3CT,+K,+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-BinaryHeap%3CT,+K,+N%3E" class="impl"><a href="#impl-BorrowMut%3CT%3E-for-BinaryHeap%3CT,+K,+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-BinaryHeap%3CT,+K,+N%3E" class="impl"><a href="#impl-From%3CT%3E-for-BinaryHeap%3CT,+K,+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-BinaryHeap%3CT,+K,+N%3E" class="impl"><a href="#impl-Into%3CU%3E-for-BinaryHeap%3CT,+K,+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-BinaryHeap%3CT,+K,+N%3E" class="impl"><a href="#impl-TryFrom%3CU%3E-for-BinaryHeap%3CT,+K,+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" class="associatedtype trait-impl"><a href="#associatedtype.Error" 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-BinaryHeap%3CT,+K,+N%3E" class="impl"><a href="#impl-TryInto%3CU%3E-for-BinaryHeap%3CT,+K,+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-1" class="associatedtype trait-impl"><a href="#associatedtype.Error-1" 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> |