mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-12-25 11:29:33 +01:00
68 lines
37 KiB
HTML
68 lines
37 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="Controls time and alarms time is a 64 bit value indicating the time in usec since power-on timeh is the top 32 bits of time & timel is the bottom 32 bits to change time write to timelw before timehw to read time read from timelr before timehr An alarm is set by setting alarm_enable and writing to the corresponding alarm register When an alarm is pending, the corresponding alarm_running signal will be high An alarm can be cancelled before it has finished by clearing the alarm_enable When an alarm fires, the corresponding alarm_irq is set and alarm_running is cleared To clear the interrupt write a 1 to the corresponding alarm_irq"><title>TIMER 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-b0742ba02757f159.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.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="../rp2040_pac/index.html">rp2040_<wbr>pac</a><span class="version">0.6.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">TIMER</a></h2><h3><a href="#implementations">Associated Constants</a></h3><ul class="block associatedconstant"><li><a href="#associatedconstant.PTR" title="PTR">PTR</a></li></ul><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.ptr" title="ptr">ptr</a></li><li><a href="#method.steal" title="steal">steal</a></li></ul><h3><a href="#deref-methods-RegisterBlock">Methods from Deref<<wbr>Target=<wbr>Register<wbr>Block></a></h3><ul class="block deref-methods"><li><a href="#method.alarm0" title="alarm0">alarm0</a></li><li><a href="#method.alarm1" title="alarm1">alarm1</a></li><li><a href="#method.alarm2" title="alarm2">alarm2</a></li><li><a href="#method.alarm3" title="alarm3">alarm3</a></li><li><a href="#method.armed" title="armed">armed</a></li><li><a href="#method.dbgpause" title="dbgpause">dbgpause</a></li><li><a href="#method.inte" title="inte">inte</a></li><li><a href="#method.intf" title="intf">intf</a></li><li><a href="#method.intr" title="intr">intr</a></li><li><a href="#method.ints" title="ints">ints</a></li><li><a href="#method.pause" title="pause">pause</a></li><li><a href="#method.timehr" title="timehr">timehr</a></li><li><a href="#method.timehw" title="timehw">timehw</a></li><li><a href="#method.timelr" title="timelr">timelr</a></li
|
||
|
|
time is a 64 bit value indicating the time in usec since power-on<br />
|
||
|
|
timeh is the top 32 bits of time & timel is the bottom 32 bits<br />
|
||
|
|
to change time write to timelw before timehw<br />
|
||
|
|
to read time read from timelr before timehr<br />
|
||
|
|
An alarm is set by setting alarm_enable and writing to the corresponding alarm register<br />
|
||
|
|
When an alarm is pending, the corresponding alarm_running signal will be high<br />
|
||
|
|
An alarm can be cancelled before it has finished by clearing the alarm_enable<br />
|
||
|
|
When an alarm fires, the corresponding alarm_irq is set and alarm_running is cleared<br />
|
||
|
|
To clear the interrupt write a 1 to the corresponding alarm_irq</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-TIMER" class="impl"><a class="src rightside" href="../src/rp2040_pac/lib.rs.html#1628-1654">source</a><a href="#impl-TIMER" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.TIMER.html" title="struct rp2040_pac::TIMER">TIMER</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/rp2040_pac/lib.rs.html#1630">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.83.0/core/primitive.pointer.html">*const </a><a class="struct" href="timer/struct.RegisterBlock.html" title="struct rp2040_pac::timer::RegisterBlock">RegisterBlock</a> = {0x40054000 as *const timer::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/rp2040_pac/lib.rs.html#1633-1635">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.83.0/core/primitive.pointer.html">*const </a><a class="struct" href="timer/struct.RegisterBlock.html" title="struct rp2040_pac::timer::RegisterBlock">RegisterBlock</a></h4></section></summary><div class="docblock"><p>Return the pointer to the register block</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.steal" class="method"><a class="src rightside" href="../src/rp2040_pac/lib.rs.html#1649-1653">source</a><h4 class="code-header">pub unsafe fn <a href="#method.steal" class="fn">steal</a>() -> Self</h4></section></summary><div class="docblock"><p>Steal an instance of this peripheral</p>
|
||
|
|
<h5 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h5>
|
||
|
|
<p>Ensure that the new instance of the peripheral cannot be used in a way
|
||
|
|
that may race with any existing instances, for example by only
|
||
|
|
accessing read-only or write-only registers, or by consuming the
|
||
|
|
original peripheral and using critical sections to coordinate
|
||
|
|
access between multiple new instances.</p>
|
||
|
|
<p>Additionally, other software such as HALs may rely on only one
|
||
|
|
peripheral instance existing to ensure memory safety; ensure
|
||
|
|
no stolen instances are passed to such software.</p>
|
||
|
|
</div></details></div></details></div><details class="toggle big-toggle" open><summary><h2 id="deref-methods-RegisterBlock" class="section-header"><span>Methods from <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a><Target = <a class="struct" href="timer/struct.RegisterBlock.html" title="struct rp2040_pac::timer::RegisterBlock">RegisterBlock</a>></span><a href="#deref-methods-RegisterBlock" class="anchor">§</a></h2></summary><div id="deref-methods-RegisterBlock-1" class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.timehw" class="method"><a class="src rightside" href="../src/rp2040_pac/timer.rs.html#26-28">source</a><h4 class="code-header">pub fn <a href="#method.timehw" class="fn">timehw</a>(&self) -> &<a class="type" href="timer/type.TIMEHW.html" title="type rp2040_pac::timer::TIMEHW">TIMEHW</a></h4></section></summary><div class="docblock"><p>0x00 - Write to bits 63:32 of time<br />
|
||
|
|
always write timelw before timehw</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.timelw" class="method"><a class="src rightside" href="../src/rp2040_pac/timer.rs.html#32-34">source</a><h4 class="code-header">pub fn <a href="#method.timelw" class="fn">timelw</a>(&self) -> &<a class="type" href="timer/type.TIMELW.html" title="type rp2040_pac::timer::TIMELW">TIMELW</a></h4></section></summary><div class="docblock"><p>0x04 - Write to bits 31:0 of time<br />
|
||
|
|
writes do not get copied to time until timehw is written</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.timehr" class="method"><a class="src rightside" href="../src/rp2040_pac/timer.rs.html#38-40">source</a><h4 class="code-header">pub fn <a href="#method.timehr" class="fn">timehr</a>(&self) -> &<a class="type" href="timer/type.TIMEHR.html" title="type rp2040_pac::timer::TIMEHR">TIMEHR</a></h4></section></summary><div class="docblock"><p>0x08 - Read from bits 63:32 of time<br />
|
||
|
|
always read timelr before timehr</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.timelr" class="method"><a class="src rightside" href="../src/rp2040_pac/timer.rs.html#43-45">source</a><h4 class="code-header">pub fn <a href="#method.timelr" class="fn">timelr</a>(&self) -> &<a class="type" href="timer/type.TIMELR.html" title="type rp2040_pac::timer::TIMELR">TIMELR</a></h4></section></summary><div class="docblock"><p>0x0c - Read from bits 31:0 of time</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.alarm0" class="method"><a class="src rightside" href="../src/rp2040_pac/timer.rs.html#51-53">source</a><h4 class="code-header">pub fn <a href="#method.alarm0" class="fn">alarm0</a>(&self) -> &<a class="type" href="timer/type.ALARM0.html" title="type rp2040_pac::timer::ALARM0">ALARM0</a></h4></section></summary><div class="docblock"><p>0x10 - Arm alarm 0, and configure the time it will fire.<br />
|
||
|
|
Once armed, the alarm fires when TIMER_ALARM0 == TIMELR.<br />
|
||
|
|
The alarm will disarm itself once it fires, and can<br />
|
||
|
|
be disarmed early using the ARMED status register.</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.alarm1" class="method"><a class="src rightside" href="../src/rp2040_pac/timer.rs.html#59-61">source</a><h4 class="code-header">pub fn <a href="#method.alarm1" class="fn">alarm1</a>(&self) -> &<a class="type" href="timer/type.ALARM1.html" title="type rp2040_pac::timer::ALARM1">ALARM1</a></h4></section></summary><div class="docblock"><p>0x14 - Arm alarm 1, and configure the time it will fire.<br />
|
||
|
|
Once armed, the alarm fires when TIMER_ALARM1 == TIMELR.<br />
|
||
|
|
The alarm will disarm itself once it fires, and can<br />
|
||
|
|
be disarmed early using the ARMED status register.</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.alarm2" class="method"><a class="src rightside" href="../src/rp2040_pac/timer.rs.html#67-69">source</a><h4 class="code-header">pub fn <a href="#method.alarm2" class="fn">alarm2</a>(&self) -> &<a class="type" href="timer/type.ALARM2.html" title="type rp2040_pac::timer::ALARM2">ALARM2</a></h4></section></summary><div class="docblock"><p>0x18 - Arm alarm 2, and configure the time it will fire.<br />
|
||
|
|
Once armed, the alarm fires when TIMER_ALARM2 == TIMELR.<br />
|
||
|
|
The alarm will disarm itself once it fires, and can<br />
|
||
|
|
be disarmed early using the ARMED status register.</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.alarm3" class="method"><a class="src rightside" href="../src/rp2040_pac/timer.rs.html#75-77">source</a><h4 class="code-header">pub fn <a href="#method.alarm3" class="fn">alarm3</a>(&self) -> &<a class="type" href="timer/type.ALARM3.html" title="type rp2040_pac::timer::ALARM3">ALARM3</a></h4></section></summary><div class="docblock"><p>0x1c - Arm alarm 3, and configure the time it will fire.<br />
|
||
|
|
Once armed, the alarm fires when TIMER_ALARM3 == TIMELR.<br />
|
||
|
|
The alarm will disarm itself once it fires, and can<br />
|
||
|
|
be disarmed early using the ARMED status register.</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.armed" class="method"><a class="src rightside" href="../src/rp2040_pac/timer.rs.html#83-85">source</a><h4 class="code-header">pub fn <a href="#method.armed" class="fn">armed</a>(&self) -> &<a class="type" href="timer/type.ARMED.html" title="type rp2040_pac::timer::ARMED">ARMED</a></h4></section></summary><div class="docblock"><p>0x20 - Indicates the armed/disarmed status of each alarm.<br />
|
||
|
|
A write to the corresponding ALARMx register arms the alarm.<br />
|
||
|
|
Alarms automatically disarm upon firing, but writing ones here<br />
|
||
|
|
will disarm immediately without waiting to fire.</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.timerawh" class="method"><a class="src rightside" href="../src/rp2040_pac/timer.rs.html#88-90">source</a><h4 class="code-header">pub fn <a href="#method.timerawh" class="fn">timerawh</a>(&self) -> &<a class="type" href="timer/type.TIMERAWH.html" title="type rp2040_pac::timer::TIMERAWH">TIMERAWH</a></h4></section></summary><div class="docblock"><p>0x24 - Raw read from bits 63:32 of time (no side effects)</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.timerawl" class="method"><a class="src rightside" href="../src/rp2040_pac/timer.rs.html#93-95">source</a><h4 class="code-header">pub fn <a href="#method.timerawl" class="fn">timerawl</a>(&self) -> &<a class="type" href="timer/type.TIMERAWL.html" title="type rp2040_pac::timer::TIMERAWL">TIMERAWL</a></h4></section></summary><div class="docblock"><p>0x28 - Raw read from bits 31:0 of time (no side effects)</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.dbgpause" class="method"><a class="src rightside" href="../src/rp2040_pac/timer.rs.html#98-100">source</a><h4 class="code-header">pub fn <a href="#method.dbgpause" class="fn">dbgpause</a>(&self) -> &<a class="type" href="timer/type.DBGPAUSE.html" title="type rp2040_pac::timer::DBGPAUSE">DBGPAUSE</a></h4></section></summary><div class="docblock"><p>0x2c - Set bits high to enable pause when the corresponding debug ports are active</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.pause" class="method"><a class="src rightside" href="../src/rp2040_pac/timer.rs.html#103-105">source</a><h4 class="code-header">pub fn <a href="#method.pause" class="fn">pause</a>(&self) -> &<a class="type" href="timer/type.PAUSE.html" title="type rp2040_pac::timer::PAUSE">PAUSE</a></h4></section></summary><div class="docblock"><p>0x30 - Set high to pause the timer</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.intr" class="method"><a class="src rightside" href="../src/rp2040_pac/timer.rs.html#108-110">source</a><h4 class="code-header">pub fn <a href="#method.intr" class="fn">intr</a>(&self) -> &<a class="type" href="timer/type.INTR.html" title="type rp2040_pac::timer::INTR">INTR</a></h4></section></summary><div class="docblock"><p>0x34 - Raw Interrupts</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.inte" class="method"><a class="src rightside" href="../src/rp2040_pac/timer.rs.html#113-115">source</a><h4 class="code-header">pub fn <a href="#method.inte" class="fn">inte</a>(&self) -> &<a class="type" href="timer/type.INTE.html" title="type rp2040_pac::timer::INTE">INTE</a></h4></section></summary><div class="docblock"><p>0x38 - Interrupt Enable</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.intf" class="method"><a class="src rightside" href="../src/rp2040_pac/timer.rs.html#118-120">source</a><h4 class="code-header">pub fn <a href="#method.intf" class="fn">intf</a>(&self) -> &<a class="type" href="timer/type.INTF.html" title="type rp2040_pac::timer::INTF">INTF</a></h4></section></summary><div class="docblock"><p>0x3c - Interrupt Force</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.ints" class="method"><a class="src rightside" href="../src/rp2040_pac/timer.rs.html#123-125">source</a><h4 class="code-header">pub fn <a href="#method.ints" class="fn">ints</a>(&self) -> &<a class="type" href="timer/type.INTS.html" title="type rp2040_pac::timer::INTS">INTS</a></h4></section></summary><div class="docblock"><p>0x40 - Interrupt status after masking & forcing</p>
|
||
|
|
</div></details></div></details><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-TIMER" class="impl"><a class="src rightside" href="../src/rp2040_pac/lib.rs.html#1662-1666">source</a><a href="#impl-Debug-for-TIMER" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.TIMER.html" title="struct rp2040_pac::TIMER">TIMER</a></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/rp2040_pac/lib.rs.html#1663-1665">source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.83.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.83.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.83.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Deref-for-TIMER" class="impl"><a class="src rightside" href="../src/rp2040_pac/lib.rs.html#1655-1661">source</a><a href="#impl-Deref-for-TIMER" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a> for <a class="struct" href="struct.TIMER.html" title="struct rp2040_pac::TIMER">TIMER</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/rp2040_pac/lib.rs.html#1656">source</a><a href="#associatedtype.Target" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.83.0/core/ops/deref/trait.Deref.html#associatedtype.Target" class="associatedtype">Target</a> = <a class="struct" href="timer/struct.RegisterBlock.html" title="struct rp2040_pac::timer::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/rp2040_pac/lib.rs.html#1658-1660">source</a><a href="#method.deref" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/ops/deref/trait.Deref.html#tymethod.deref" class="fn">deref</a>(&self) -> &Self::<a class="associatedtype" href="https://doc.rust-lang.org/1.83.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-TIMER" class="impl"><a class="src rightside" href="../src/rp2040_pac/lib.rs.html#1627">source</a><a href="#impl-Send-for-TIMER" class="anchor">§</a><h3 class="code-header">impl <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.TIMER.html" title="struct rp2040_pac::TIMER">TIMER</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
|
||
|
|
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/any.rs.html#139">source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.83.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.83.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/borrow.rs.html#209">source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<div class="where">where
|
||
|
|
T: ?<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/borrow.rs.html#211">source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/borrow.rs.html#217">source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<div class="where">where
|
||
|
|
T: ?<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/borrow.rs.html#218">source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#765">source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#768">source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
||
|
|
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#748-750">source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<div class="where">where
|
||
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#758">source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
|
||
|
|
<p>That is, this conversion is whatever the implementation of
|
||
|
|
<code><a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
|
||
|
|
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#805-807">source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<div class="where">where
|
||
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#809">source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#812">source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#790-792">source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<div class="where">where
|
||
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#794">source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#797">source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html>
|