mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-12-26 11:59:33 +01:00
56 lines
33 KiB
HTML
56 lines
33 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="SysTick: System Timer"><title>SYST in rp2040_pac - 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-492a78a4a87dcc01.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="rp2040_pac" data-themes="" data-resource-suffix="" data-rustdoc-version="1.82.0 (f6e511eec 2024-10-15)" data-channel="1.82.0" data-search-js="search-a99f1315e7cc5121.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-921df33f47b8780c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-3b12f09e550e0385.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="../rp2040_pac/index.html">rp2040_<wbr>pac</a><span class="version">0.6.0</span></h2></div><h2 class="location"><a href="#">SYST</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Associated Constants</a></h3><ul class="block associatedconstant"><li><a href="#associatedconstant.PTR">PTR</a></li></ul><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.clear_current">clear_current</a></li><li><a href="#method.disable_counter">disable_counter</a></li><li><a href="#method.disable_interrupt">disable_interrupt</a></li><li><a href="#method.enable_counter">enable_counter</a></li><li><a href="#method.enable_interrupt">enable_interrupt</a></li><li><a href="#method.get_clock_source">get_clock_source</a></li><li><a href="#method.get_current">get_current</a></li><li><a href="#method.get_reload">get_reload</a></li><li><a href="#method.get_ticks_per_10ms">get_ticks_per_10ms</a></li><li><a href="#method.has_reference_clock">has_reference_clock</a></li><li><a href="#method.has_wrapped">has_wrapped</a></li><li><a href="#method.is_counter_enabled">is_counter_enabled</a></li><li><a href="#method.is_interrupt_enabled">is_interrupt_enabled</a></li><li><a href="#method.is_precise">is_precise</a></li><li><a href="#method.ptr">ptr</a></li><li><a href="#method.set_clock_source">set_clock_source</a></li><li><a href="#method.set_reload">set_reload</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Deref-for-SYST">Deref</a></li><li><a href="#impl-Send-for-SYST">Send</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Sync-for-SYST">!Sync</a></li><li><a href="#impl-Freeze-for-SYST">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-SYST">RefUnwindSafe</a></li><li><a href="#impl-Unpin-for-SYST">Unpin</a></li><li><a href="#impl-UnwindSafe-for-SYST">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class
|
||
|
|
</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-SYST" class="impl"><a class="src rightside" href="../src/cortex_m/peripheral/syst.rs.html#39">source</a><a href="#impl-SYST" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.SYST.html" title="struct rp2040_pac::SYST">SYST</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clear_current" class="method"><a class="src rightside" href="../src/cortex_m/peripheral/syst.rs.html#44">source</a><h4 class="code-header">pub fn <a href="#method.clear_current" class="fn">clear_current</a>(&mut self)</h4></section></summary><div class="docblock"><p>Clears current value to 0</p>
|
||
|
|
<p>After calling <code>clear_current()</code>, the next call to <code>has_wrapped()</code> will return <code>false</code>.</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.disable_counter" class="method"><a class="src rightside" href="../src/cortex_m/peripheral/syst.rs.html#50">source</a><h4 class="code-header">pub fn <a href="#method.disable_counter" class="fn">disable_counter</a>(&mut self)</h4></section></summary><div class="docblock"><p>Disables counter</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.disable_interrupt" class="method"><a class="src rightside" href="../src/cortex_m/peripheral/syst.rs.html#56">source</a><h4 class="code-header">pub fn <a href="#method.disable_interrupt" class="fn">disable_interrupt</a>(&mut self)</h4></section></summary><div class="docblock"><p>Disables SysTick interrupt</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.enable_counter" class="method"><a class="src rightside" href="../src/cortex_m/peripheral/syst.rs.html#73">source</a><h4 class="code-header">pub fn <a href="#method.enable_counter" class="fn">enable_counter</a>(&mut self)</h4></section></summary><div class="docblock"><p>Enables counter</p>
|
||
|
|
<p><em>NOTE</em> The reference manual indicates that:</p>
|
||
|
|
<p>“The SysTick counter reload and current value are undefined at reset, the correct
|
||
|
|
initialization sequence for the SysTick counter is:</p>
|
||
|
|
<ul>
|
||
|
|
<li>Program reload value</li>
|
||
|
|
<li>Clear current value</li>
|
||
|
|
<li>Program Control and Status register“</li>
|
||
|
|
</ul>
|
||
|
|
<p>The sequence translates to <code>self.set_reload(x); self.clear_current(); self.enable_counter()</code></p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.enable_interrupt" class="method"><a class="src rightside" href="../src/cortex_m/peripheral/syst.rs.html#79">source</a><h4 class="code-header">pub fn <a href="#method.enable_interrupt" class="fn">enable_interrupt</a>(&mut self)</h4></section></summary><div class="docblock"><p>Enables SysTick interrupt</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_clock_source" class="method"><a class="src rightside" href="../src/cortex_m/peripheral/syst.rs.html#88">source</a><h4 class="code-header">pub fn <a href="#method.get_clock_source" class="fn">get_clock_source</a>(&mut self) -> <a class="enum" href="../cortex_m/peripheral/syst/enum.SystClkSource.html" title="enum cortex_m::peripheral::syst::SystClkSource">SystClkSource</a></h4></section></summary><div class="docblock"><p>Gets clock source</p>
|
||
|
|
<p><em>NOTE</em> This takes <code>&mut self</code> because the read operation is side effectful and can clear the
|
||
|
|
bit that indicates that the timer has wrapped (cf. <code>SYST.has_wrapped</code>)</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_current" class="method"><a class="src rightside" href="../src/cortex_m/peripheral/syst.rs.html#99">source</a><h4 class="code-header">pub fn <a href="#method.get_current" class="fn">get_current</a>() -> <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.u32.html">u32</a></h4></section></summary><div class="docblock"><p>Gets current value</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_reload" class="method"><a class="src rightside" href="../src/cortex_m/peripheral/syst.rs.html#106">source</a><h4 class="code-header">pub fn <a href="#method.get_reload" class="fn">get_reload</a>() -> <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.u32.html">u32</a></h4></section></summary><div class="docblock"><p>Gets reload value</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_ticks_per_10ms" class="method"><a class="src rightside" href="../src/cortex_m/peripheral/syst.rs.html#117">source</a><h4 class="code-header">pub fn <a href="#method.get_ticks_per_10ms" class="fn">get_ticks_per_10ms</a>() -> <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.u32.html">u32</a></h4></section></summary><div class="docblock"><p>Returns the reload value with which the counter would wrap once per 10
|
||
|
|
ms</p>
|
||
|
|
<p>Returns <code>0</code> if the value is not known (e.g. because the clock can
|
||
|
|
change dynamically).</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.has_reference_clock" class="method"><a class="src rightside" href="../src/cortex_m/peripheral/syst.rs.html#124">source</a><h4 class="code-header">pub fn <a href="#method.has_reference_clock" class="fn">has_reference_clock</a>() -> <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Checks if an external reference clock is available</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.has_wrapped" class="method"><a class="src rightside" href="../src/cortex_m/peripheral/syst.rs.html#134">source</a><h4 class="code-header">pub fn <a href="#method.has_wrapped" class="fn">has_wrapped</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Checks if the counter wrapped (underflowed) since the last check</p>
|
||
|
|
<p><em>NOTE</em> This takes <code>&mut self</code> because the read operation is side effectful and will clear
|
||
|
|
the bit of the read register.</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_counter_enabled" class="method"><a class="src rightside" href="../src/cortex_m/peripheral/syst.rs.html#143">source</a><h4 class="code-header">pub fn <a href="#method.is_counter_enabled" class="fn">is_counter_enabled</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Checks if counter is enabled</p>
|
||
|
|
<p><em>NOTE</em> This takes <code>&mut self</code> because the read operation is side effectful and can clear the
|
||
|
|
bit that indicates that the timer has wrapped (cf. <code>SYST.has_wrapped</code>)</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_interrupt_enabled" class="method"><a class="src rightside" href="../src/cortex_m/peripheral/syst.rs.html#152">source</a><h4 class="code-header">pub fn <a href="#method.is_interrupt_enabled" class="fn">is_interrupt_enabled</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Checks if SysTick interrupt is enabled</p>
|
||
|
|
<p><em>NOTE</em> This takes <code>&mut self</code> because the read operation is side effectful and can clear the
|
||
|
|
bit that indicates that the timer has wrapped (cf. <code>SYST.has_wrapped</code>)</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_precise" class="method"><a class="src rightside" href="../src/cortex_m/peripheral/syst.rs.html#162">source</a><h4 class="code-header">pub fn <a href="#method.is_precise" class="fn">is_precise</a>() -> <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Checks if the calibration value is precise</p>
|
||
|
|
<p>Returns <code>false</code> if using the reload value returned by
|
||
|
|
<code>get_ticks_per_10ms()</code> may result in a period significantly deviating
|
||
|
|
from 10 ms.</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_clock_source" class="method"><a class="src rightside" href="../src/cortex_m/peripheral/syst.rs.html#169">source</a><h4 class="code-header">pub fn <a href="#method.set_clock_source" class="fn">set_clock_source</a>(&mut self, clk_source: <a class="enum" href="../cortex_m/peripheral/syst/enum.SystClkSource.html" title="enum cortex_m::peripheral::syst::SystClkSource">SystClkSource</a>)</h4></section></summary><div class="docblock"><p>Sets clock source</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_reload" class="method"><a class="src rightside" href="../src/cortex_m/peripheral/syst.rs.html#182">source</a><h4 class="code-header">pub fn <a href="#method.set_reload" class="fn">set_reload</a>(&mut self, value: <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.u32.html">u32</a>)</h4></section></summary><div class="docblock"><p>Sets reload value</p>
|
||
|
|
<p>Valid values are between <code>1</code> and <code>0x00ffffff</code>.</p>
|
||
|
|
<p><em>NOTE</em> To make the timer wrap every <code>N</code> ticks set the reload value to <code>N - 1</code></p>
|
||
|
|
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-SYST-1" class="impl"><a class="src rightside" href="../src/cortex_m/peripheral/mod.rs.html#636">source</a><a href="#impl-SYST-1" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.SYST.html" title="struct rp2040_pac::SYST">SYST</a></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedconstant.PTR" class="associatedconstant"><a class="src rightside" href="../src/cortex_m/peripheral/mod.rs.html#638">source</a><h4 class="code-header">pub const <a href="#associatedconstant.PTR" class="constant">PTR</a>: <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.pointer.html">*const </a><a class="struct" href="../cortex_m/peripheral/syst/struct.RegisterBlock.html" title="struct cortex_m::peripheral::syst::RegisterBlock">RegisterBlock</a> = {0xe000e010 as *const cortex_m::peripheral::syst::RegisterBlock}</h4></section></summary><div class="docblock"><p>Pointer to the register block</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.ptr" class="method"><a class="src rightside" href="../src/cortex_m/peripheral/mod.rs.html#643">source</a><h4 class="code-header">pub const fn <a href="#method.ptr" class="fn">ptr</a>() -> <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.pointer.html">*const </a><a class="struct" href="../cortex_m/peripheral/syst/struct.RegisterBlock.html" title="struct cortex_m::peripheral::syst::RegisterBlock">RegisterBlock</a></h4></section><span class="item-info"><div class="stab deprecated"><span class="emoji">👎</span><span>Deprecated since 0.7.5: Use the associated constant <code>PTR</code> instead</span></div></span></summary><div class="docblock"><p>Returns a pointer to the register block</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-Deref-for-SYST" class="impl"><a class="src rightside" href="../src/cortex_m/peripheral/mod.rs.html#648">source</a><a href="#impl-Deref-for-SYST" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a> for <a class="struct" href="struct.SYST.html" title="struct rp2040_pac::SYST">SYST</a></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Target" class="associatedtype trait-impl"><a class="src rightside" href="../src/cortex_m/peripheral/mod.rs.html#649">source</a><a href="#associatedtype.Target" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.82.0/core/ops/deref/trait.Deref.html#associatedtype.Target" class="associatedtype">Target</a> = <a class="struct" href="../cortex_m/peripheral/syst/struct.RegisterBlock.html" title="struct cortex_m::peripheral::syst::RegisterBlock">RegisterBlock</a></h4></section></summary><div class='docblock'>The resulting type after dereferencing.</div></details><details class="toggle method-toggle" open><summary><section id="method.deref" class="method trait-impl"><a class="src rightside" href="../src/cortex_m/peripheral/mod.rs.html#652">source</a><a href="#method.deref" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.82.0/core/ops/deref/trait.Deref.html#tymethod.deref" class="fn">deref</a>(&self) -> &<<a class="struct" href="struct.SYST.html" title="struct rp2040_pac::SYST">SYST</a> as <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.82.0/core/ops/deref/trait.Deref.html#associatedtype.Target" title="type core::ops::deref::Deref::Target">Target</a></h4></section></summary><div class='docblock'>Dereferences the value.</div></details></div></details><section id="impl-Send-for-SYST" class="impl"><a class="src rightside" href="../src/cortex_m/peripheral/mod.rs.html#634">source</a><a href="#impl-Send-for-SYST" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.SYST.html" title="struct rp2040_pac::SYST">SYST</a></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-SYST" class="impl"><a href="#impl-Freeze-for-SYST" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.SYST.html" title="struct rp2040_pac::SYST">SYST</a></h3></section><section id="impl-RefUnwindSafe-for-SYST" class="impl"><a href="#impl-RefUnwindSafe-for-SYST" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.SYST.html" title="struct rp2040_pac::SYST">SYST</a></h3></section><section id="impl-Sync-for-SYST" class="impl"><a href="#impl-Sync-for-SYST" class="anchor">§</a><h3 class="code-header">impl !<a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.SYST.html" title="struct rp2040_pac::SYST">SYST</a></h3></section><
|
||
|
|
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.82.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.82.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.82.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.82.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.82.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.82.0/src/core/borrow.rs.html#209">source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<div class="where">where
|
||
|
|
T: ?<a class="trait" href="https://doc.rust-lang.org/1.82.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.82.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.82.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.82.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.82.0/src/core/borrow.rs.html#217">source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<div class="where">where
|
||
|
|
T: ?<a class="trait" href="https://doc.rust-lang.org/1.82.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.82.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.82.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.82.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.82.0/src/core/convert/mod.rs.html#765">source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.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.82.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
||
|
|
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.0/src/core/convert/mod.rs.html#748-750">source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<div class="where">where
|
||
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.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.82.0/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
|
||
|
|
<p>That is, this conversion is whatever the implementation of
|
||
|
|
<code><a href="https://doc.rust-lang.org/1.82.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
|
||
|
|
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.0/src/core/convert/mod.rs.html#805-807">source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<div class="where">where
|
||
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.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.82.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.82.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.82.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.82.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.0/src/core/convert/mod.rs.html#790-792">source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<div class="where">where
|
||
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.82.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.82.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.82.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.82.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.82.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.82.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html>
|