mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-12-26 11:59:33 +01:00
199 lines
No EOL
52 KiB
HTML
199 lines
No EOL
52 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 heapless::binary_heap - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-b0742ba02757f159.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.83.0 (90b35a623 2024-11-26)" data-channel="1.83.0" data-search-js="search-f0d225181b97f9a4.js" data-settings-js="settings-805db61a62df4bd2.js" ><script src="../../static.files/storage-1d39b6787ed640ff.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-f070b9041d14864c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-0111fcff984fae8f.css"></noscript><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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../heapless/index.html">heapless</a><span class="version">0.8.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Binary<wbr>Heap</a></h2><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.capacity" title="capacity">capacity</a></li><li><a href="#method.clear" title="clear">clear</a></li><li><a href="#method.into_vec" title="into_vec">into_vec</a></li><li><a href="#method.is_empty" title="is_empty">is_empty</a></li><li><a href="#method.iter" title="iter">iter</a></li><li><a href="#method.iter_mut" title="iter_mut">iter_mut</a></li><li><a href="#method.len" title="len">len</a></li><li><a href="#method.new" title="new">new</a></li><li><a href="#method.peek" title="peek">peek</a></li><li><a href="#method.peek_mut" title="peek_mut">peek_mut</a></li><li><a href="#method.pop" title="pop">pop</a></li><li><a href="#method.pop_unchecked" title="pop_unchecked">pop_unchecked</a></li><li><a href="#method.push" title="push">push</a></li><li><a href="#method.push_unchecked" title="push_unchecked">push_unchecked</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Clone-for-BinaryHeap%3CT,+K,+N%3E" title="Clone">Clone</a></li><li><a href="#impl-Debug-for-BinaryHeap%3CT,+K,+N%3E" title="Debug">Debug</a></li><li><a href="#impl-Default-for-BinaryHeap%3CT,+K,+N%3E" title="Default">Default</a></li><li><a href="#impl-IntoIterator-for-%26BinaryHeap%3CT,+K,+N%3E" title="IntoIterator">IntoIterator</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-BinaryHeap%3CT,+K,+N%3E" title="Freeze">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-BinaryHeap%3CT,+K,+N%3E" title="RefUnwindSafe">RefUnwindSafe</a></li><li><a href="#impl-Send-for-BinaryHeap%3CT,+K,+N%3E" title="Send">Send</a></li><li><a href="#impl-Sync-for-BinaryHeap%3CT,+K,+N%3E" title="Sync">Sync</a></li><li><a href="#impl-Unpin-for-BinaryHeap%3CT,+K,+N%3E" title="Unpin">Unpin</a></li><li><a href="#impl-UnwindSafe-for-BinaryHeap%3CT,+K,+N%3E" title="UnwindSafe">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T" title="Any">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T" title="Borrow<T>">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T" title="BorrowMut<T>">BorrowMut<T></a></li><li><a href="#impl-CloneToUninit-for-T" title="CloneToUninit">CloneToUninit</a></li><li><a href="#impl-From%3CT%3E-for-T" title="From<T>">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-T" title="Into<U>">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-T" title="TryFrom<U>">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-T" title="TryInto<U>">TryInto<U></a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In heapless::<wbr>binary_<wbr>heap</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">heapless</a>::<wbr><a href="index.html">binary_heap</a></span><h1>Struct <span class="struct">BinaryHeap</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/binary_heap.rs.html#101-104">source</a> </span></div><pre class="rust item-decl"><code>pub struct BinaryHeap<T, K, const N: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.usize.html">usize</a>> { <span class="comment">/* private fields */</span> }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>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="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-126">source</a><a href="#impl-BinaryHeap%3CT,+K,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, K, const N: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.usize.html">usize</a>> <a class="struct" href="struct.BinaryHeap.html" title="struct heapless::binary_heap::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-125">source</a><h4 class="code-header">pub const fn <a href="#method.new" class="fn">new</a>() -> Self</h4></section></summary><div class="docblock"><p>Creates an empty 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-380">source</a><a href="#impl-BinaryHeap%3CT,+K,+N%3E-1" class="anchor">§</a><h3 class="code-header">impl<T, K, const N: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.usize.html">usize</a>> <a class="struct" href="struct.BinaryHeap.html" title="struct heapless::binary_heap::BinaryHeap">BinaryHeap</a><T, K, N><div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a>,
|
||
K: <a class="trait" href="trait.Kind.html" title="trait heapless::binary_heap::Kind">Kind</a>,</div></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-137">source</a><h4 class="code-header">pub fn <a href="#method.capacity" class="fn">capacity</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.usize.html">usize</a></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-156">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-171">source</a><h4 class="code-header">pub fn <a href="#method.len" class="fn">len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.usize.html">usize</a></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-190">source</a><h4 class="code-header">pub fn <a href="#method.is_empty" class="fn">is_empty</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.bool.html">bool</a></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-211">source</a><h4 class="code-header">pub fn <a href="#method.iter" class="fn">iter</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.83.0/core/slice/iter/struct.Iter.html" title="struct core::slice::iter::Iter">Iter</a><'_, 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-219">source</a><h4 class="code-header">pub fn <a href="#method.iter_mut" class="fn">iter_mut</a>(&mut self) -> <a class="struct" href="https://doc.rust-lang.org/1.83.0/core/slice/iter/struct.IterMut.html" title="struct core::slice::iter::IterMut">IterMut</a><'_, 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-237">source</a><h4 class="code-header">pub fn <a href="#method.peek" class="fn">peek</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&T</a>></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-274">source</a><h4 class="code-header">pub fn <a href="#method.peek_mut" class="fn">peek_mut</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="struct.PeekMut.html" title="struct 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 class="doc-anchor" href="#examples">§</a>Examples</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-296">source</a><h4 class="code-header">pub fn <a href="#method.pop" class="fn">pop</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><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-308">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-330">source</a><h4 class="code-header">pub fn <a href="#method.push" class="fn">push</a>(&mut self, item: T) -> <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.unit.html">()</a>, 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-337">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-342">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 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="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#529-540">source</a><a href="#impl-Clone-for-BinaryHeap%3CT,+K,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, K, const N: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="struct.BinaryHeap.html" title="struct heapless::binary_heap::BinaryHeap">BinaryHeap</a><T, K, N><div class="where">where
|
||
K: <a class="trait" href="trait.Kind.html" title="trait heapless::binary_heap::Kind">Kind</a>,
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl"><a class="src rightside" href="../../src/heapless/binary_heap.rs.html#534-539">source</a><a href="#method.clone" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/clone/trait.Clone.html#tymethod.clone" class="fn">clone</a>(&self) -> Self</h4></section></summary><div class='docblock'>Returns a copy of the value. <a href="https://doc.rust-lang.org/1.83.0/core/clone/trait.Clone.html#tymethod.clone">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.83.0/src/core/clone.rs.html#174">source</a></span><a href="#method.clone_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/clone/trait.Clone.html#method.clone_from" class="fn">clone_from</a>(&mut self, source: &Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/1.83.0/core/clone/trait.Clone.html#method.clone_from">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#542-550">source</a><a href="#impl-Debug-for-BinaryHeap%3CT,+K,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, K, const N: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.BinaryHeap.html" title="struct heapless::binary_heap::BinaryHeap">BinaryHeap</a><T, K, N><div class="where">where
|
||
K: <a class="trait" href="trait.Kind.html" title="trait heapless::binary_heap::Kind">Kind</a>,
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../../src/heapless/binary_heap.rs.html#547-549">source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.83.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.83.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.83.0/core/fmt/trait.Debug.html#tymethod.fmt">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#519-527">source</a><a href="#impl-Default-for-BinaryHeap%3CT,+K,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, K, const N: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="struct.BinaryHeap.html" title="struct heapless::binary_heap::BinaryHeap">BinaryHeap</a><T, K, N><div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a>,
|
||
K: <a class="trait" href="trait.Kind.html" title="trait heapless::binary_heap::Kind">Kind</a>,</div></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#524-526">source</a><a href="#method.default" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/default/trait.Default.html#tymethod.default" class="fn">default</a>() -> Self</h4></section></summary><div class='docblock'>Returns the “default value” for a type. <a href="https://doc.rust-lang.org/1.83.0/core/default/trait.Default.html#tymethod.default">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-IntoIterator-for-%26BinaryHeap%3CT,+K,+N%3E" class="impl"><a class="src rightside" href="../../src/heapless/binary_heap.rs.html#552-563">source</a><a href="#impl-IntoIterator-for-%26BinaryHeap%3CT,+K,+N%3E" class="anchor">§</a><h3 class="code-header">impl<'a, T, K, const N: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a> for &'a <a class="struct" href="struct.BinaryHeap.html" title="struct heapless::binary_heap::BinaryHeap">BinaryHeap</a><T, K, N><div class="where">where
|
||
K: <a class="trait" href="trait.Kind.html" title="trait heapless::binary_heap::Kind">Kind</a>,
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Item" class="associatedtype trait-impl"><a class="src rightside" href="../../src/heapless/binary_heap.rs.html#557">source</a><a href="#associatedtype.Item" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.83.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" class="associatedtype">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&'a T</a></h4></section></summary><div class='docblock'>The type of the elements being iterated over.</div></details><details class="toggle" open><summary><section id="associatedtype.IntoIter" class="associatedtype trait-impl"><a class="src rightside" href="../../src/heapless/binary_heap.rs.html#558">source</a><a href="#associatedtype.IntoIter" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.83.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" class="associatedtype">IntoIter</a> = <a class="struct" href="https://doc.rust-lang.org/1.83.0/core/slice/iter/struct.Iter.html" title="struct core::slice::iter::Iter">Iter</a><'a, T></h4></section></summary><div class='docblock'>Which kind of iterator are we turning this into?</div></details><details class="toggle method-toggle" open><summary><section id="method.into_iter" class="method trait-impl"><a class="src rightside" href="../../src/heapless/binary_heap.rs.html#560-562">source</a><a href="#method.into_iter" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter" class="fn">into_iter</a>(self) -> Self::<a class="associatedtype" href="https://doc.rust-lang.org/1.83.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" title="type core::iter::traits::collect::IntoIterator::IntoIter">IntoIter</a></h4></section></summary><div class='docblock'>Creates an iterator from a value. <a href="https://doc.rust-lang.org/1.83.0/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter">Read more</a></div></details></div></details></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-BinaryHeap%3CT,+K,+N%3E" class="impl"><a href="#impl-Freeze-for-BinaryHeap%3CT,+K,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, K, const N: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.BinaryHeap.html" title="struct heapless::binary_heap::BinaryHeap">BinaryHeap</a><T, K, N><div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a>,</div></h3></section><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: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.BinaryHeap.html" title="struct heapless::binary_heap::BinaryHeap">BinaryHeap</a><T, K, N><div class="where">where
|
||
K: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a>,
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a>,</div></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: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.BinaryHeap.html" title="struct heapless::binary_heap::BinaryHeap">BinaryHeap</a><T, K, N><div class="where">where
|
||
K: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</div></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: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.BinaryHeap.html" title="struct heapless::binary_heap::BinaryHeap">BinaryHeap</a><T, K, N><div class="where">where
|
||
K: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,</div></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: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.BinaryHeap.html" title="struct heapless::binary_heap::BinaryHeap">BinaryHeap</a><T, K, N><div class="where">where
|
||
K: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></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: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.usize.html">usize</a>> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.BinaryHeap.html" title="struct heapless::binary_heap::BinaryHeap">BinaryHeap</a><T, K, N><div class="where">where
|
||
K: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a>,
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a>,</div></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/any.rs.html#138">source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
|
||
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/any.rs.html#139">source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.83.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.83.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/borrow.rs.html#209">source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/borrow.rs.html#211">source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/borrow.rs.html#217">source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/borrow.rs.html#218">source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CloneToUninit-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/clone.rs.html#273">source</a><a href="#impl-CloneToUninit-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/clone/trait.CloneToUninit.html" title="trait core::clone::CloneToUninit">CloneToUninit</a> for T<div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone_to_uninit" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/clone.rs.html#275">source</a><a href="#method.clone_to_uninit" class="anchor">§</a><h4 class="code-header">unsafe fn <a href="https://doc.rust-lang.org/1.83.0/core/clone/trait.CloneToUninit.html#tymethod.clone_to_uninit" class="fn">clone_to_uninit</a>(&self, dst: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.pointer.html">*mut T</a>)</h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>clone_to_uninit</code>)</span></div></span><div class='docblock'>Performs copy-assignment from <code>self</code> to <code>dst</code>. <a href="https://doc.rust-lang.org/1.83.0/core/clone/trait.CloneToUninit.html#tymethod.clone_to_uninit">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#765">source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#768">source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#748-750">source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#758">source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
|
||
<p>That is, this conversion is whatever the implementation of
|
||
<code><a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#805-807">source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#809">source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#812">source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#790-792">source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#794">source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#797">source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html> |