Files
phy/offset_allocator/struct.Allocator.html
Orion Kindel 0ce894e6b0 doc
2025-03-18 10:30:23 -05:00

45 lines
30 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="An allocator that manages a single contiguous chunk of space and hands out portions of it as requested."><title>Allocator in offset_allocator - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.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" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="offset_allocator" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.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]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../offset_allocator/index.html">offset_<wbr>allocator</a><span class="version">0.2.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Allocator</a></h2><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.allocate" title="allocate">allocate</a></li><li><a href="#method.allocation_size" title="allocation_size">allocation_size</a></li><li><a href="#method.free" title="free">free</a></li><li><a href="#method.new" title="new">new</a></li><li><a href="#method.reset" title="reset">reset</a></li><li><a href="#method.storage_report" title="storage_report">storage_report</a></li><li><a href="#method.storage_report_full" title="storage_report_full">storage_report_full</a></li><li><a href="#method.with_max_allocs" title="with_max_allocs">with_max_allocs</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Debug-for-Allocator%3CNI%3E" title="Debug">Debug</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-Allocator%3CNI%3E" title="Freeze">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-Allocator%3CNI%3E" title="RefUnwindSafe">RefUnwindSafe</a></li><li><a href="#impl-Send-for-Allocator%3CNI%3E" title="Send">Send</a></li><li><a href="#impl-Sync-for-Allocator%3CNI%3E" title="Sync">Sync</a></li><li><a href="#impl-Unpin-for-Allocator%3CNI%3E" title="Unpin">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Allocator%3CNI%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&#60;T&#62;">Borrow&#60;T&#62;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T" title="BorrowMut&#60;T&#62;">BorrowMut&#60;T&#62;</a></li><li><a href="#impl-From%3CT%3E-for-T" title="From&#60;T&#62;">From&#60;T&#62;</a></li><li><a href="#impl-Into%3CU%3E-for-T" title="Into&#60;U&#62;">Into&#60;U&#62;</a></li><li><a href="#impl-TryFrom%3CU%3E-for-T" title="TryFrom&#60;U&#62;">TryFrom&#60;U&#62;</a></li><li><a href="#impl-TryInto%3CU%3E-for-T" title="TryInto&#60;U&#62;">TryInto&#60;U&#62;</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate offset_<wbr>allocator</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">offset_allocator</a></span><h1>Struct <span class="struct">Allocator</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/offset_allocator/lib.rs.html#57-72">Source</a> </span></div><pre class="rust item-decl"><code>pub struct Allocator&lt;NI = <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>&gt;<div class="where">where
NI: <a class="trait" href="trait.NodeIndex.html" title="trait offset_allocator::NodeIndex">NodeIndex</a>,</div>{ <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>An allocator that manages a single contiguous chunk of space and hands out
portions of it as requested.</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-Allocator%3CNI%3E" class="impl"><a class="src rightside" href="../src/offset_allocator/lib.rs.html#137-537">Source</a><a href="#impl-Allocator%3CNI%3E" class="anchor">§</a><h3 class="code-header">impl&lt;NI&gt; <a class="struct" href="struct.Allocator.html" title="struct offset_allocator::Allocator">Allocator</a>&lt;NI&gt;<div class="where">where
NI: <a class="trait" href="trait.NodeIndex.html" title="trait offset_allocator::NodeIndex">NodeIndex</a>,</div></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/offset_allocator/lib.rs.html#143-145">Source</a><h4 class="code-header">pub fn <a href="#method.new" class="fn">new</a>(size: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>) -&gt; Self</h4></section></summary><div class="docblock"><p>Creates a new allocator, managing a contiguous block of memory of <code>size</code>
units, with a default reasonable number of maximum allocations.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.with_max_allocs" class="method"><a class="src rightside" href="../src/offset_allocator/lib.rs.html#153-169">Source</a><h4 class="code-header">pub fn <a href="#method.with_max_allocs" class="fn">with_max_allocs</a>(size: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>, max_allocs: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>) -&gt; Self</h4></section></summary><div class="docblock"><p>Creates a new allocator, managing a contiguous block of memory of <code>size</code>
units, with the given number of maximum allocations.</p>
<p>Note that the maximum number of allocations must be less than
<a href="trait.NodeIndex.html#associatedconstant.MAX" title="associated constant offset_allocator::NodeIndex::MAX"><code>NodeIndex::MAX</code></a> minus one. If this restriction is violated, this
constructor will panic.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.reset" class="method"><a class="src rightside" href="../src/offset_allocator/lib.rs.html#172-193">Source</a><h4 class="code-header">pub fn <a href="#method.reset" class="fn">reset</a>(&amp;mut self)</h4></section></summary><div class="docblock"><p>Clears out all allocations.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.allocate" class="method"><a class="src rightside" href="../src/offset_allocator/lib.rs.html#199-297">Source</a><h4 class="code-header">pub fn <a href="#method.allocate" class="fn">allocate</a>(&amp;mut self, size: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="struct.Allocation.html" title="struct offset_allocator::Allocation">Allocation</a>&lt;NI&gt;&gt;</h4></section></summary><div class="docblock"><p>Allocates a block of <code>size</code> elements and returns its allocation.</p>
<p>If theres not enough contiguous space for this allocation, returns
None.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.free" class="method"><a class="src rightside" href="../src/offset_allocator/lib.rs.html#305-381">Source</a><h4 class="code-header">pub fn <a href="#method.free" class="fn">free</a>(&amp;mut self, allocation: <a class="struct" href="struct.Allocation.html" title="struct offset_allocator::Allocation">Allocation</a>&lt;NI&gt;)</h4></section></summary><div class="docblock"><p>Frees an allocation, returning the data to the heap.</p>
<p>If the allocation has already been freed, the behavior is unspecified.
It may or may not panic. Note that, because this crate contains no
unsafe code, the memory safe of the allocator <em>itself</em> will be
uncompromised, even on double free.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.allocation_size" class="method"><a class="src rightside" href="../src/offset_allocator/lib.rs.html#486-491">Source</a><h4 class="code-header">pub fn <a href="#method.allocation_size" class="fn">allocation_size</a>(&amp;self, allocation: <a class="struct" href="struct.Allocation.html" title="struct offset_allocator::Allocation">Allocation</a>&lt;NI&gt;) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a></h4></section></summary><div class="docblock"><p>Returns the <em>used</em> size of an allocation.</p>
<p>Note that this may be larger than the size requested at allocation time,
due to rounding.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.storage_report" class="method"><a class="src rightside" href="../src/offset_allocator/lib.rs.html#495-517">Source</a><h4 class="code-header">pub fn <a href="#method.storage_report" class="fn">storage_report</a>(&amp;self) -&gt; <a class="struct" href="struct.StorageReport.html" title="struct offset_allocator::StorageReport">StorageReport</a></h4></section></summary><div class="docblock"><p>Returns a structure containing the amount of free space remaining, as
well as the largest amount that can be allocated at once.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.storage_report_full" class="method"><a class="src rightside" href="../src/offset_allocator/lib.rs.html#521-536">Source</a><h4 class="code-header">pub fn <a href="#method.storage_report_full" class="fn">storage_report_full</a>(&amp;self) -&gt; <a class="struct" href="struct.StorageReportFull.html" title="struct offset_allocator::StorageReportFull">StorageReportFull</a></h4></section></summary><div class="docblock"><p>Returns detailed information about the number of allocations in each
bin.</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-Debug-for-Allocator%3CNI%3E" class="impl"><a class="src rightside" href="../src/offset_allocator/lib.rs.html#547-554">Source</a><a href="#impl-Debug-for-Allocator%3CNI%3E" class="anchor">§</a><h3 class="code-header">impl&lt;NI&gt; <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.Allocator.html" title="struct offset_allocator::Allocator">Allocator</a>&lt;NI&gt;<div class="where">where
NI: <a class="trait" href="trait.NodeIndex.html" title="trait offset_allocator::NodeIndex">NodeIndex</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/offset_allocator/lib.rs.html#551-553">Source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/1.84.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>&lt;'_&gt;) -&gt; <a class="type" href="https://doc.rust-lang.org/1.84.0/core/fmt/type.Result.html" title="type core::fmt::Result">FmtResult</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html#tymethod.fmt">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-Allocator%3CNI%3E" class="impl"><a href="#impl-Freeze-for-Allocator%3CNI%3E" class="anchor">§</a><h3 class="code-header">impl&lt;NI&gt; <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.Allocator.html" title="struct offset_allocator::Allocator">Allocator</a>&lt;NI&gt;<div class="where">where
&lt;NI as <a class="trait" href="trait.NodeIndex.html" title="trait offset_allocator::NodeIndex">NodeIndex</a>&gt;::<a class="associatedtype" href="trait.NodeIndex.html#associatedtype.NonMax" title="type offset_allocator::NodeIndex::NonMax">NonMax</a>: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a>,</div></h3></section><section id="impl-RefUnwindSafe-for-Allocator%3CNI%3E" class="impl"><a href="#impl-RefUnwindSafe-for-Allocator%3CNI%3E" class="anchor">§</a><h3 class="code-header">impl&lt;NI&gt; <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.Allocator.html" title="struct offset_allocator::Allocator">Allocator</a>&lt;NI&gt;<div class="where">where
&lt;NI as <a class="trait" href="trait.NodeIndex.html" title="trait offset_allocator::NodeIndex">NodeIndex</a>&gt;::<a class="associatedtype" href="trait.NodeIndex.html#associatedtype.NonMax" title="type offset_allocator::NodeIndex::NonMax">NonMax</a>: <a class="trait" href="https://doc.rust-lang.org/1.84.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-Allocator%3CNI%3E" class="impl"><a href="#impl-Send-for-Allocator%3CNI%3E" class="anchor">§</a><h3 class="code-header">impl&lt;NI&gt; <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.Allocator.html" title="struct offset_allocator::Allocator">Allocator</a>&lt;NI&gt;<div class="where">where
&lt;NI as <a class="trait" href="trait.NodeIndex.html" title="trait offset_allocator::NodeIndex">NodeIndex</a>&gt;::<a class="associatedtype" href="trait.NodeIndex.html#associatedtype.NonMax" title="type offset_allocator::NodeIndex::NonMax">NonMax</a>: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</div></h3></section><section id="impl-Sync-for-Allocator%3CNI%3E" class="impl"><a href="#impl-Sync-for-Allocator%3CNI%3E" class="anchor">§</a><h3 class="code-header">impl&lt;NI&gt; <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.Allocator.html" title="struct offset_allocator::Allocator">Allocator</a>&lt;NI&gt;<div class="where">where
&lt;NI as <a class="trait" href="trait.NodeIndex.html" title="trait offset_allocator::NodeIndex">NodeIndex</a>&gt;::<a class="associatedtype" href="trait.NodeIndex.html#associatedtype.NonMax" title="type offset_allocator::NodeIndex::NonMax">NonMax</a>: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,</div></h3></section><section id="impl-Unpin-for-Allocator%3CNI%3E" class="impl"><a href="#impl-Unpin-for-Allocator%3CNI%3E" class="anchor">§</a><h3 class="code-header">impl&lt;NI&gt; <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.Allocator.html" title="struct offset_allocator::Allocator">Allocator</a>&lt;NI&gt;<div class="where">where
&lt;NI as <a class="trait" href="trait.NodeIndex.html" title="trait offset_allocator::NodeIndex">NodeIndex</a>&gt;::<a class="associatedtype" href="trait.NodeIndex.html#associatedtype.NonMax" title="type offset_allocator::NodeIndex::NonMax">NonMax</a>: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h3></section><section id="impl-UnwindSafe-for-Allocator%3CNI%3E" class="impl"><a href="#impl-UnwindSafe-for-Allocator%3CNI%3E" class="anchor">§</a><h3 class="code-header">impl&lt;NI&gt; <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.Allocator.html" title="struct offset_allocator::Allocator">Allocator</a>&lt;NI&gt;<div class="where">where
&lt;NI as <a class="trait" href="trait.NodeIndex.html" title="trait offset_allocator::NodeIndex">NodeIndex</a>&gt;::<a class="associatedtype" href="trait.NodeIndex.html#associatedtype.NonMax" title="type offset_allocator::NodeIndex::NonMax">NonMax</a>: <a class="trait" href="https://doc.rust-lang.org/1.84.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.84.0/src/core/any.rs.html#138">Source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.84.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.84.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.84.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.84.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.84.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.84.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.84.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&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a>&lt;T&gt; for T<div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.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.84.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.84.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&amp;T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.84.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.84.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&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a>&lt;T&gt; for T<div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.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.84.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.84.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&amp;mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.84.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-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.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&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; 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.84.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.84.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -&gt; 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.84.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&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt;,</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.84.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.84.0/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -&gt; 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.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; 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.84.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&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;T&gt;,</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.84.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.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.84.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.84.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.84.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, &lt;T as <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</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.84.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&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;,</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.84.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.84.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = &lt;U as <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.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.84.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.84.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;U, &lt;U as <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html>