rtic/stable/api/nrf52840_pac/generic/struct.Reg.html

77 lines
32 KiB
HTML
Raw Normal View History

<!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="This structure provides volatile access to registers."><title>Reg in nrf52840_pac::generic - 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="nrf52840_pac" 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="../../nrf52840_pac/index.html">nrf52840_<wbr>pac</a><span class="version">0.12.2</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Reg</a></h2><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.as_ptr" title="as_ptr">as_ptr</a></li><li><a href="#method.modify" title="modify">modify</a></li><li><a href="#method.read" title="read">read</a></li><li><a href="#method.reset" title="reset">reset</a></li><li><a href="#method.write" title="write">write</a></li><li><a href="#method.write_with_zero" title="write_with_zero">write_with_zero</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Send-for-Reg%3CREG%3E" title="Send">Send</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-Reg%3CREG%3E" title="!Freeze">!Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-Reg%3CREG%3E" title="!RefUnwindSafe">!RefUnwindSafe</a></li><li><a href="#impl-Sync-for-Reg%3CREG%3E" title="!Sync">!Sync</a></li><li><a href="#impl-Unpin-for-Reg%3CREG%3E" title="Unpin">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Reg%3CREG%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&#
</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-Reg%3CREG%3E" class="impl"><a class="src rightside" href="../../src/nrf52840_pac/generic.rs.html#38-48">source</a><a href="#impl-Reg%3CREG%3E" class="anchor">§</a><h3 class="code-header">impl&lt;REG: <a class="trait" href="trait.RegisterSpec.html" title="trait nrf52840_pac::generic::RegisterSpec">RegisterSpec</a>&gt; <a class="struct" href="struct.Reg.html" title="struct nrf52840_pac::generic::Reg">Reg</a>&lt;REG&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.as_ptr" class="method"><a class="src rightside" href="../../src/nrf52840_pac/generic.rs.html#45-47">source</a><h4 class="code-header">pub fn <a href="#method.as_ptr" class="fn">as_ptr</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.pointer.html">*mut </a>REG::<a class="associatedtype" href="trait.RegisterSpec.html#associatedtype.Ux" title="type nrf52840_pac::generic::RegisterSpec::Ux">Ux</a></h4></section></summary><div class="docblock"><p>Returns the underlying memory address of register.</p>
<div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested"></a><pre class="rust rust-example-rendered"><code><span class="kw">let </span>reg_ptr = periph.reg.as_ptr();</code></pre></div>
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Reg%3CREG%3E-1" class="impl"><a class="src rightside" href="../../src/nrf52840_pac/generic.rs.html#49-69">source</a><a href="#impl-Reg%3CREG%3E-1" class="anchor">§</a><h3 class="code-header">impl&lt;REG: <a class="trait" href="trait.Readable.html" title="trait nrf52840_pac::generic::Readable">Readable</a>&gt; <a class="struct" href="struct.Reg.html" title="struct nrf52840_pac::generic::Reg">Reg</a>&lt;REG&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.read" class="method"><a class="src rightside" href="../../src/nrf52840_pac/generic.rs.html#63-68">source</a><h4 class="code-header">pub fn <a href="#method.read" class="fn">read</a>(&amp;self) -&gt; REG::<a class="associatedtype" href="trait.Readable.html#associatedtype.Reader" title="type nrf52840_pac::generic::Readable::Reader">Reader</a></h4></section></summary><div class="docblock"><p>Reads the contents of a <code>Readable</code> register.</p>
<p>You can read the raw contents of a register by using <code>bits</code>:</p>
<div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested"></a><pre class="rust rust-example-rendered"><code><span class="kw">let </span>bits = periph.reg.read().bits();</code></pre></div>
<p>or get the content of a particular field of a register:</p>
<div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested"></a><pre class="rust rust-example-rendered"><code><span class="kw">let </span>reader = periph.reg.read();
<span class="kw">let </span>bits = reader.field1().bits();
<span class="kw">let </span>flag = reader.field2().bit_is_set();</code></pre></div>
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Reg%3CREG%3E-2" class="impl"><a class="src rightside" href="../../src/nrf52840_pac/generic.rs.html#70-114">source</a><a href="#impl-Reg%3CREG%3E-2" class="anchor">§</a><h3 class="code-header">impl&lt;REG: <a class="trait" href="trait.Resettable.html" title="trait nrf52840_pac::generic::Resettable">Resettable</a> + <a class="trait" href="trait.Writable.html" title="trait nrf52840_pac::generic::Writable">Writable</a>&gt; <a class="struct" href="struct.Reg.html" title="struct nrf52840_pac::generic::Reg">Reg</a>&lt;REG&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.reset" class="method"><a class="src rightside" href="../../src/nrf52840_pac/generic.rs.html#75-77">source</a><h4 class="code-header">pub fn <a href="#method.reset" class="fn">reset</a>(&amp;self)</h4></section></summary><div class="docblock"><p>Writes the reset value to <code>Writable</code> register.</p>
<p>Resets the register to its initial state.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.write" class="method"><a class="src rightside" href="../../src/nrf52840_pac/generic.rs.html#102-113">source</a><h4 class="code-header">pub fn <a href="#method.write" class="fn">write</a>&lt;F&gt;(&amp;self, f: F)<div class="where">where
F: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(&amp;mut REG::<a class="associatedtype" href="trait.Writable.html#associatedtype.Writer" title="type nrf52840_pac::generic::Writable::Writer">Writer</a>) -&gt; &amp;mut <a class="struct" href="struct.W.html" title="struct nrf52840_pac::generic::W">W</a>&lt;REG&gt;,</div></h4></section></summary><div class="docblock"><p>Writes bits to a <code>Writable</code> register.</p>
<p>You can write raw bits into a register:</p>
<div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested"></a><pre class="rust rust-example-rendered"><code>periph.reg.write(|w| <span class="kw">unsafe </span>{ w.bits(rawbits) });</code></pre></div>
<p>or write only the fields you need:</p>
<div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested"></a><pre class="rust rust-example-rendered"><code>periph.reg.write(|w| w
.field1().bits(newfield1bits)
.field2().set_bit()
.field3().variant(VARIANT)
);</code></pre></div>
<p>or an alternative way of saying the same:</p>
<div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested"></a><pre class="rust rust-example-rendered"><code>periph.reg.write(|w| {
w.field1().bits(newfield1bits);
w.field2().set_bit();
w.field3().variant(VARIANT)
});</code></pre></div>
<p>In the latter case, other fields will be set to their reset value.</p>
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Reg%3CREG%3E-3" class="impl"><a class="src rightside" href="../../src/nrf52840_pac/generic.rs.html#115-135">source</a><a href="#impl-Reg%3CREG%3E-3" class="anchor">§</a><h3 class="code-header">impl&lt;REG: <a class="trait" href="trait.Writable.html" title="trait nrf52840_pac::generic::Writable">Writable</a>&gt; <a class="struct" href="struct.Reg.html" title="struct nrf52840_pac::generic::Reg">Reg</a>&lt;REG&gt;<div class="where">where
REG::<a class="associatedtype" href="trait.RegisterSpec.html#associatedtype.Ux" title="type nrf52840_pac::generic::RegisterSpec::Ux">Ux</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>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.write_with_zero" class="method"><a class="src rightside" href="../../src/nrf52840_pac/generic.rs.html#123-134">source</a><h4 class="code-header">pub unsafe fn <a href="#method.write_with_zero" class="fn">write_with_zero</a>&lt;F&gt;(&amp;self, f: F)<div class="where">where
F: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(&amp;mut REG::<a class="associatedtype" href="trait.Writable.html#associatedtype.Writer" title="type nrf52840_pac::generic::Writable::Writer">Writer</a>) -&gt; &amp;mut <a class="struct" href="struct.W.html" title="struct nrf52840_pac::generic::W">W</a>&lt;REG&gt;,</div></h4></section></summary><div class="docblock"><p>Writes 0 to a <code>Writable</code> register.</p>
<p>Similar to <code>write</code>, but unused bits will contain 0.</p>
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Reg%3CREG%3E-4" class="impl"><a class="src rightside" href="../../src/nrf52840_pac/generic.rs.html#136-182">source</a><a href="#impl-Reg%3CREG%3E-4" class="anchor">§</a><h3 class="code-header">impl&lt;REG: <a class="trait" href="trait.Readable.html" title="trait nrf52840_pac::generic::Readable">Readable</a> + <a class="trait" href="trait.Writable.html" title="trait nrf52840_pac::generic::Writable">Writable</a>&gt; <a class="struct" href="struct.Reg.html" title="struct nrf52840_pac::generic::Reg">Reg</a>&lt;REG&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.modify" class="method"><a class="src rightside" href="../../src/nrf52840_pac/generic.rs.html#163-181">source</a><h4 class="code-header">pub fn <a href="#method.modify" class="fn">modify</a>&lt;F&gt;(&amp;self, f: F)<div class="where">where
for&lt;'w&gt; F: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(&amp;REG::<a class="associatedtype" href="trait.Readable.html#associatedtype.Reader" title="type nrf52840_pac::generic::Readable::Reader">Reader</a>, &amp;'w mut REG::<a class="associatedtype" href="trait.Writable.html#associatedtype.Writer" title="type nrf52840_pac::generic::Writable::Writer">Writer</a>) -&gt; &amp;'w mut <a class="struct" href="struct.W.html" title="struct nrf52840_pac::generic::W">W</a>&lt;REG&gt;,</div></h4></section></summary><div class="docblock"><p>Modifies the contents of the register by reading and then writing it.</p>
<p>E.g. to do a read-modify-write sequence to change parts of a register:</p>
<div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested"></a><pre class="rust rust-example-rendered"><code>periph.reg.modify(|r, w| <span class="kw">unsafe </span>{ w.bits(
r.bits() | <span class="number">3
</span>) });</code></pre></div>
<p>or</p>
<div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested"></a><pre class="rust rust-example-rendered"><code>periph.reg.modify(|<span class="kw">_</span>, w| w
.field1().bits(newfield1bits)
.field2().set_bit()
.field3().variant(VARIANT)
);</code></pre></div>
<p>or an alternative way of saying the same:</p>
<div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested"></a><pre class="rust rust-example-rendered"><code>periph.reg.modify(|<span class="kw">_</span>, w| {
w.field1().bits(newfield1bits);
w.field2().set_bit();
w.field3().variant(VARIANT)
});</code></pre></div>
<p>Other fields will have the value they had before the call to <code>modify</code>.</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"><section id="impl-Send-for-Reg%3CREG%3E" class="impl"><a class="src rightside" href="../../src/nrf52840_pac/generic.rs.html#37">source</a><a href="#impl-Send-for-Reg%3CREG%3E" class="anchor">§</a><h3 class="code-header">impl&lt;REG: <a class="trait" href="trait.RegisterSpec.html" title="trait nrf52840_pac::generic::RegisterSpec">RegisterSpec</a>&gt; <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.Reg.html" title="struct nrf52840_pac::generic::Reg">Reg</a>&lt;REG&gt;<div class="where">where
REG::<a class="associatedtype" href="trait.RegisterSpec.html#associatedtype.Ux" title="type nrf52840_pac::generic::RegisterSpec::Ux">Ux</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>,</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-Reg%3CREG%3E" class="impl"><a href="#impl-Freeze-for-Reg%3CREG%3E" class="anchor">§</a><h3 class="code-header">impl&lt;REG&gt; !<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.Reg.html" title="struct nrf52840_pac::generic::Reg">Reg</a>&lt;REG&gt;</h3></section><section id="impl-RefUnwindSafe-for-Reg%3CREG%3E" class="impl"><a href="#impl-RefUnwindSafe-for-Reg%3CREG%3E" class="anchor">§</a><h3 class="code-header">impl&lt;REG&gt; !<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.Reg.html" title="struct nrf52840_pac::generic::Reg">Reg</a>&lt;REG&gt;</h3></section><section id="impl-Sync-for-Reg%3CREG%3E" class="impl"><a href="#impl-Sync-for-Reg%3CREG%3E" class="anchor">§</a><h3 class="code-header">impl&lt;REG&gt; !<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.Reg.html" title="struct nrf52840_pac::generic::Reg">Reg</a>&lt;REG&gt;</h3></section><section id="impl-Unpin-for-Reg%3CREG%3E" class="impl"><a href="#impl-Unpin-for-Reg%3CREG%3E" class="anchor">§</a><h3 class="code-header">impl&lt;REG&gt; <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.Reg.html" title="struct nrf52840_pac::generic::Reg">Reg</a>&lt;REG&gt;<div class="where">where
REG: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,
&lt;REG as <a class="trait" href="trait.RegisterSpec.html" title="trait nrf52840_pac::generic::RegisterSpec">RegisterSpec</a>&gt;::<a class="associatedtype" href="trait.RegisterSpec.html#associatedtype.Ux" title="type nrf52840_pac::generic::RegisterSpec::Ux">Ux</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>,</div></h3></section><section id="impl-UnwindSafe-for-Reg%3CREG%3E" class="impl"><a href="#impl-UnwindSafe-for-Reg%3CREG%3E" class="anchor">§</a><h3 class="code-header">impl&lt;REG&gt; <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.Reg.html" title="struct nrf52840_pac::generic::Reg">Reg</a>&lt;REG&gt;<div class="where">where
REG: <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>,
&lt;REG as <a class="trait" href="trait.RegisterSpec.html" title="trait nrf52840_pac::generic::RegisterSpec">RegisterSpec</a>&gt;::<a class="associatedtype" href="trait.RegisterSpec.html#associatedtype.Ux" title="type nrf52840_pac::generic::RegisterSpec::Ux">Ux</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>,</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&lt;T&gt; <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>(&amp;self) -&gt; <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&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.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.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>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/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.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&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.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.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>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/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.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-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&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.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.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) -&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.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&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.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.83.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.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) -&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.83.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.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&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.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.83.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.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) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.83.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.83.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.83.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.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&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.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.83.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.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> = &lt;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>&lt;T&gt;&gt;::<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) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.83.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.83.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.83.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>