mirror of
https://github.com/rtic-rs/rtic.git
synced 2025-12-21 07:15:32 +01:00
59 lines
No EOL
31 KiB
HTML
59 lines
No EOL
31 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="Base struct for `Queue` and `QueueView`, generic over the `Storage`."><title>QueueInner in heapless::mpmc - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-e56847b5.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="heapless" data-themes="" data-resource-suffix="" data-rustdoc-version="1.91.1 (ed61e7d7e 2025-11-07)" data-channel="1.91.1" data-search-js="search-e256b49e.js" data-stringdex-js="stringdex-c3e638e9.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-6dc2a7f3.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">QueueInner</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../heapless/index.html">heapless</a><span class="version">0.9.2</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Queue<wbr>Inner</a></h2><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.as_mut_view" title="as_mut_view">as_mut_view</a></li><li><a href="#method.as_view" title="as_view">as_view</a></li><li><a href="#method.capacity" title="capacity">capacity</a></li><li><a href="#method.dequeue" title="dequeue">dequeue</a></li><li><a href="#method.enqueue" title="enqueue">enqueue</a></li><li><a href="#method.new" title="new">new</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Drop-for-QueueInner%3CT,+S%3E" title="Drop">Drop</a></li><li><a href="#impl-Sync-for-QueueInner%3CT,+S%3E" title="Sync">Sync</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-QueueInner%3CT,+S%3E" title="!Freeze">!Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-QueueInner%3CT,+S%3E" title="!RefUnwindSafe">!RefUnwindSafe</a></li><li><a href="#impl-Send-for-QueueInner%3CT,+S%3E" title="Send">Send</a></li><li><a href="#impl-Unpin-for-QueueInner%3CT,+S%3E" title="Unpin">Unpin</a></li><li><a href="#impl-UnwindSafe-for-QueueInner%3CT,+S%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-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>mpmc</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">heapless</a>::<wbr><a href="index.html">mpmc</a></div><h1>Struct <span class="struct">Queue<wbr>Inner</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/mpmc.rs.html#130-134">Source</a> </span></div><pre class="rust item-decl"><code>pub struct QueueInner<T, S: <a class="trait" href="../storage/trait.Storage.html" title="trait heapless::storage::Storage">Storage</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>Base struct for <a href="type.Queue.html" title="type heapless::mpmc::Queue"><code>Queue</code></a> and <a href="type.QueueView.html" title="type heapless::mpmc::QueueView"><code>QueueView</code></a>, generic over the <a href="../storage/trait.Storage.html" title="trait heapless::storage::Storage"><code>Storage</code></a>.</p>
|
||
<p>In most cases you should use <a href="type.Queue.html" title="type heapless::mpmc::Queue"><code>Queue</code></a> or <a href="type.QueueView.html" title="type heapless::mpmc::QueueView"><code>QueueView</code></a> directly. Only use this
|
||
struct if you want to write code that’s generic over both.</p>
|
||
</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-QueueInner%3CT,+OwnedStorage%3CN%3E%3E" class="impl"><a class="src rightside" href="../../src/heapless/mpmc.rs.html#153-216">Source</a><a href="#impl-QueueInner%3CT,+OwnedStorage%3CN%3E%3E" class="anchor">§</a><h3 class="code-header">impl<T, const N: <a class="primitive" href="https://doc.rust-lang.org/1.91.1/core/primitive.usize.html">usize</a>> <a class="struct" href="struct.QueueInner.html" title="struct heapless::mpmc::QueueInner">QueueInner</a><T, <a class="enum" href="../storage/enum.OwnedStorage.html" title="enum heapless::storage::OwnedStorage">OwnedStorage</a><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/mpmc.rs.html#186-206">Source</a><h4 class="code-header">pub const fn <a href="#method.new" class="fn">new</a>() -> Self</h4></section><span class="item-info"><div class="stab deprecated"><span class="emoji">👎</span><span>Deprecated: See the documentation of Queue::new() for more information: https://docs.rs/heapless/latest/heapless/mpmc/type.Queue.html#method.new</span></div></span></summary><div class="docblock"><p>Creates an empty queue.</p>
|
||
<h5 id="deprecation"><a class="doc-anchor" href="#deprecation">§</a>Deprecation</h5><div class="warning">
|
||
The current implementation of `mpmc` is marked as deprecated due to not being truly
|
||
lock-free </div>
|
||
<p>If a thread is parked, or pre-empted for a long time by an higher-priority task
|
||
during an <code>enqueue</code> or <code>dequeue</code> operation, it is possible that the queue ends-up
|
||
in a state were no other task can successfully enqueue or dequeue items from it
|
||
until the pre-empted task can finish its operation.</p>
|
||
<p>In that case, <a href="struct.QueueInner.html#method.dequeue" title="method heapless::mpmc::QueueInner::dequeue"><code>enqueue</code></a> and <a href="struct.QueueInner.html#method.enqueue" title="method heapless::mpmc::QueueInner::enqueue"><code>dequeue</code></a>
|
||
will return an error, but will not panic or reach undefined behaviour</p>
|
||
<p>This makes <code>mpmc</code> unsuitable for some use cases such as using it as a pool of objects.</p>
|
||
<h6 id="when-can-this-queue-be-used"><a class="doc-anchor" href="#when-can-this-queue-be-used">§</a>When can this queue be used?</h6>
|
||
<p>This queue should be used for cross-task communication only when items sent over the queue
|
||
can be dropped in case of concurrent operations, or when it is possible to retry
|
||
the dequeue/enqueue operation after other tasks have had the opportunity to make progress.</p>
|
||
<p>In that case you can safely ignore the warnings using <code>#[expect(deprecated)]</code>
|
||
when <code>new</code> is called</p>
|
||
<p>For more information, and possible alternative, please see
|
||
<a href="https://github.com/rust-embedded/heapless/issues/583">https://github.com/rust-embedded/heapless/issues/583</a></p>
|
||
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-QueueInner%3CT,+S%3E" class="impl"><a class="src rightside" href="../../src/heapless/mpmc.rs.html#218-292">Source</a><a href="#impl-QueueInner%3CT,+S%3E" class="anchor">§</a><h3 class="code-header">impl<T, S: <a class="trait" href="../storage/trait.Storage.html" title="trait heapless::storage::Storage">Storage</a>> <a class="struct" href="struct.QueueInner.html" title="struct heapless::mpmc::QueueInner">QueueInner</a><T, S></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/mpmc.rs.html#221-223">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.91.1/core/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the maximum number of elements the queue can hold.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.as_view" class="method"><a class="src rightside" href="../../src/heapless/mpmc.rs.html#243-245">Source</a><h4 class="code-header">pub fn <a href="#method.as_view" class="fn">as_view</a>(&self) -> &<a class="type" href="type.QueueView.html" title="type heapless::mpmc::QueueView">QueueView</a><T></h4></section></summary><div class="docblock"><p>Get a reference to the <code>Queue</code>, erasing the <code>N</code> const-generic.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>queue: Queue<u8, <span class="number">2</span>> = Queue::new();
|
||
<span class="kw">let </span>view: <span class="kw-2">&</span>QueueView<u8> = queue.as_view();</code></pre></div>
|
||
<p>It is often preferable to do the same through type coerction, since <code>Queue<T, N></code> implements
|
||
<code>Unsize<QueueView<T>></code>:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>queue: Queue<u8, <span class="number">2</span>> = Queue::new();
|
||
<span class="kw">let </span>view: <span class="kw-2">&</span>QueueView<u8> = <span class="kw-2">&</span>queue;</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.as_mut_view" class="method"><a class="src rightside" href="../../src/heapless/mpmc.rs.html#266-268">Source</a><h4 class="code-header">pub fn <a href="#method.as_mut_view" class="fn">as_mut_view</a>(&mut self) -> &mut <a class="type" href="type.QueueView.html" title="type heapless::mpmc::QueueView">QueueView</a><T></h4></section></summary><div class="docblock"><p>Get a mutable reference to the <code>Queue</code>, erasing the <code>N</code> const-generic.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#[expect(deprecated)]
|
||
</span><span class="kw">let </span><span class="kw-2">mut </span>queue: Queue<u8, <span class="number">2</span>> = Queue::new();
|
||
<span class="kw">let </span>view: <span class="kw-2">&mut </span>QueueView<u8> = queue.as_mut_view();</code></pre></div>
|
||
<p>It is often preferable to do the same through type coerction, since <code>Queue<T, N></code> implements
|
||
<code>Unsize<QueueView<T>></code>:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#[expect(deprecated)]
|
||
</span><span class="kw">let </span><span class="kw-2">mut </span>queue: Queue<u8, <span class="number">2</span>> = Queue::new();
|
||
<span class="kw">let </span>view: <span class="kw-2">&mut </span>QueueView<u8> = <span class="kw-2">&mut </span>queue;</code></pre></div></div></details><details class="toggle method-toggle" open><summary><section id="method.dequeue" class="method"><a class="src rightside" href="../../src/heapless/mpmc.rs.html#275-277">Source</a><h4 class="code-header">pub fn <a href="#method.dequeue" class="fn">dequeue</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.91.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a><T></h4></section></summary><div class="docblock"><p>Returns the item in the front of the queue, or <code>None</code> if the queue is empty.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.enqueue" class="method"><a class="src rightside" href="../../src/heapless/mpmc.rs.html#282-291">Source</a><h4 class="code-header">pub fn <a href="#method.enqueue" class="fn">enqueue</a>(&self, item: T) -> <a class="enum" href="https://doc.rust-lang.org/1.91.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.91.1/core/primitive.unit.html">()</a>, T></h4></section></summary><div class="docblock"><p>Adds an <code>item</code> to the end of the queue.</p>
|
||
<p>Returns back the <code>item</code> if the queue is full.</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-Drop-for-QueueInner%3CT,+S%3E" class="impl"><a class="src rightside" href="../../src/heapless/mpmc.rs.html#301-306">Source</a><a href="#impl-Drop-for-QueueInner%3CT,+S%3E" class="anchor">§</a><h3 class="code-header">impl<T, S: <a class="trait" href="../storage/trait.Storage.html" title="trait heapless::storage::Storage">Storage</a>> <a class="trait" href="https://doc.rust-lang.org/1.91.1/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop">Drop</a> for <a class="struct" href="struct.QueueInner.html" title="struct heapless::mpmc::QueueInner">QueueInner</a><T, S></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.drop" class="method trait-impl"><a class="src rightside" href="../../src/heapless/mpmc.rs.html#302-305">Source</a><a href="#method.drop" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.91.1/core/ops/drop/trait.Drop.html#tymethod.drop" class="fn">drop</a>(&mut self)</h4></section></summary><div class='docblock'>Executes the destructor for this type. <a href="https://doc.rust-lang.org/1.91.1/core/ops/drop/trait.Drop.html#tymethod.drop">Read more</a></div></details></div></details><section id="impl-Sync-for-QueueInner%3CT,+S%3E" class="impl"><a class="src rightside" href="../../src/heapless/mpmc.rs.html#308">Source</a><a href="#impl-Sync-for-QueueInner%3CT,+S%3E" class="anchor">§</a><h3 class="code-header">impl<T, S: <a class="trait" href="../storage/trait.Storage.html" title="trait heapless::storage::Storage">Storage</a>> <a class="trait" href="https://doc.rust-lang.org/1.91.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.QueueInner.html" title="struct heapless::mpmc::QueueInner">QueueInner</a><T, S><div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.91.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</div></h3></section></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-QueueInner%3CT,+S%3E" class="impl"><a href="#impl-Freeze-for-QueueInner%3CT,+S%3E" class="anchor">§</a><h3 class="code-header">impl<T, S> !<a class="trait" href="https://doc.rust-lang.org/1.91.1/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.QueueInner.html" title="struct heapless::mpmc::QueueInner">QueueInner</a><T, S></h3></section><section id="impl-RefUnwindSafe-for-QueueInner%3CT,+S%3E" class="impl"><a href="#impl-RefUnwindSafe-for-QueueInner%3CT,+S%3E" class="anchor">§</a><h3 class="code-header">impl<T, S> !<a class="trait" href="https://doc.rust-lang.org/1.91.1/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.QueueInner.html" title="struct heapless::mpmc::QueueInner">QueueInner</a><T, S></h3></section><section id="impl-Send-for-QueueInner%3CT,+S%3E" class="impl"><a href="#impl-Send-for-QueueInner%3CT,+S%3E" class="anchor">§</a><h3 class="code-header">impl<T, S> <a class="trait" href="https://doc.rust-lang.org/1.91.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.QueueInner.html" title="struct heapless::mpmc::QueueInner">QueueInner</a><T, S><div class="where">where
|
||
<S as SealedStorage>::Buffer<Cell<T>>: <a class="trait" href="https://doc.rust-lang.org/1.91.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</div></h3></section><section id="impl-Unpin-for-QueueInner%3CT,+S%3E" class="impl"><a href="#impl-Unpin-for-QueueInner%3CT,+S%3E" class="anchor">§</a><h3 class="code-header">impl<T, S> <a class="trait" href="https://doc.rust-lang.org/1.91.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.QueueInner.html" title="struct heapless::mpmc::QueueInner">QueueInner</a><T, S><div class="where">where
|
||
<S as SealedStorage>::Buffer<Cell<T>>: <a class="trait" href="https://doc.rust-lang.org/1.91.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h3></section><section id="impl-UnwindSafe-for-QueueInner%3CT,+S%3E" class="impl"><a href="#impl-UnwindSafe-for-QueueInner%3CT,+S%3E" class="anchor">§</a><h3 class="code-header">impl<T, S> <a class="trait" href="https://doc.rust-lang.org/1.91.1/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.QueueInner.html" title="struct heapless::mpmc::QueueInner">QueueInner</a><T, S><div class="where">where
|
||
<S as SealedStorage>::Buffer<Cell<T>>: <a class="trait" href="https://doc.rust-lang.org/1.91.1/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.91.1/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.91.1/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.91.1/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.91.1/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.91.1/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.91.1/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.91.1/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.91.1/src/core/borrow.rs.html#212">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.91.1/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.91.1/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.91.1/src/core/borrow.rs.html#214">Source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.91.1/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.91.1/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.91.1/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.91.1/src/core/borrow.rs.html#221">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.91.1/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.91.1/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.91.1/src/core/borrow.rs.html#222">Source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.91.1/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.91.1/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.91.1/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">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.91.1/src/core/convert/mod.rs.html#785">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.91.1/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.91.1/src/core/convert/mod.rs.html#788">Source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.91.1/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.91.1/src/core/convert/mod.rs.html#767-769">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.91.1/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.91.1/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.91.1/src/core/convert/mod.rs.html#777">Source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.91.1/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.91.1/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.91.1/src/core/convert/mod.rs.html#827-829">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.91.1/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.91.1/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.91.1/src/core/convert/mod.rs.html#831">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.91.1/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.91.1/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.91.1/src/core/convert/mod.rs.html#834">Source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.91.1/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.91.1/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.91.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.91.1/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.91.1/src/core/convert/mod.rs.html#811-813">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.91.1/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.91.1/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.91.1/src/core/convert/mod.rs.html#815">Source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.91.1/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.91.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.91.1/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.91.1/src/core/convert/mod.rs.html#818">Source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.91.1/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.91.1/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.91.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.91.1/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> |