Files
cortex-m-quickstart/cortex_m/peripheral/struct.SYST.html
2018-09-03 15:09:46 +00:00

60 lines
33 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `SYST` struct in crate `cortex_m`."><meta name="keywords" content="rust, rustlang, rust-lang, SYST"><title>cortex_m::peripheral::SYST - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><p class='location'>Struct SYST</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.clear_current">clear_current</a><a href="#method.disable_counter">disable_counter</a><a href="#method.disable_interrupt">disable_interrupt</a><a href="#method.enable_counter">enable_counter</a><a href="#method.enable_interrupt">enable_interrupt</a><a href="#method.get_clock_source">get_clock_source</a><a href="#method.get_current">get_current</a><a href="#method.get_reload">get_reload</a><a href="#method.get_ticks_per_10ms">get_ticks_per_10ms</a><a href="#method.has_reference_clock">has_reference_clock</a><a href="#method.has_wrapped">has_wrapped</a><a href="#method.is_counter_enabled">is_counter_enabled</a><a href="#method.is_interrupt_enabled">is_interrupt_enabled</a><a href="#method.is_precise">is_precise</a><a href="#method.set_clock_source">set_clock_source</a><a href="#method.set_reload">set_reload</a><a href="#method.ptr">ptr</a></div><a class="sidebar-title" href="#deref-methods">Methods from Deref&lt;Target=RegisterBlock&gt;</a><div class="sidebar-links"></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Deref">Deref</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Sync">!Sync</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-TryFrom">TryFrom</a><a href="#impl-From">From</a><a href="#impl-TryInto">TryInto</a><a href="#impl-Into">Into</a><a href="#impl-Borrow">Borrow</a><a href="#impl-BorrowMut">BorrowMut</a><a href="#impl-Any">Any</a></div></div><p class='location'><a href='../index.html'>cortex_m</a>::<wbr><a href='index.html'>peripheral</a></p><script>window.sidebarCurrent = {name: 'SYST', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press S to search, ? for more options…" type="search"><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/cortex_m/peripheral/mod.rs.html#458-460' title='goto source code'>[src]</a></span><span class='in-band'>Struct <a href='../index.html'>cortex_m</a>::<wbr><a href='index.html'>peripheral</a>::<wbr><a class="struct" href=''>SYST</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct SYST { /* fields omitted */ }</pre></div><div class='docblock'><p>SysTick: System Timer</p>
</div><h2 id='methods' class='small-section-header'>Methods<a href='#methods' class='anchor'></a></h2><h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="struct" href="../../cortex_m/peripheral/struct.SYST.html" title="struct cortex_m::peripheral::SYST">SYST</a></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/cortex_m/peripheral/syst.rs.html#39-169' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.clear_current' class="method"><span id='clear_current.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.clear_current' class='fnname'>clear_current</a>(&amp;mut self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/cortex_m/peripheral/syst.rs.html#43-45' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><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><h4 id='method.disable_counter' class="method"><span id='disable_counter.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.disable_counter' class='fnname'>disable_counter</a>(&amp;mut self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/cortex_m/peripheral/syst.rs.html#48-50' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Disables counter</p>
</div><h4 id='method.disable_interrupt' class="method"><span id='disable_interrupt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.disable_interrupt' class='fnname'>disable_interrupt</a>(&amp;mut self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/cortex_m/peripheral/syst.rs.html#53-55' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Disables SysTick interrupt</p>
</div><h4 id='method.enable_counter' class="method"><span id='enable_counter.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.enable_counter' class='fnname'>enable_counter</a>(&amp;mut self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/cortex_m/peripheral/syst.rs.html#69-71' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Enables counter</p>
<p><em>NOTE</em> The reference manual indicates that:</p>
<p>&quot;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&quot;</li>
</ul>
<p>The sequence translates to <code>self.set_reload(x); self.clear_current(); self.enable_counter()</code></p>
</div><h4 id='method.enable_interrupt' class="method"><span id='enable_interrupt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.enable_interrupt' class='fnname'>enable_interrupt</a>(&amp;mut self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/cortex_m/peripheral/syst.rs.html#74-76' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Enables SysTick interrupt</p>
</div><h4 id='method.get_clock_source' class="method"><span id='get_clock_source.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.get_clock_source' class='fnname'>get_clock_source</a>(&amp;mut self) -&gt; <a class="enum" href="../../cortex_m/peripheral/syst/enum.SystClkSource.html" title="enum cortex_m::peripheral::syst::SystClkSource">SystClkSource</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/cortex_m/peripheral/syst.rs.html#82-89' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Gets clock source</p>
<p><em>NOTE</em> This takes <code>&amp;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><h4 id='method.get_current' class="method"><span id='get_current.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.get_current' class='fnname'>get_current</a>() -&gt; u32</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/cortex_m/peripheral/syst.rs.html#92-95' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Gets current value</p>
</div><h4 id='method.get_reload' class="method"><span id='get_reload.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.get_reload' class='fnname'>get_reload</a>() -&gt; u32</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/cortex_m/peripheral/syst.rs.html#98-101' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Gets reload value</p>
</div><h4 id='method.get_ticks_per_10ms' class="method"><span id='get_ticks_per_10ms.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.get_ticks_per_10ms' class='fnname'>get_ticks_per_10ms</a>() -&gt; u32</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/cortex_m/peripheral/syst.rs.html#108-111' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><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><h4 id='method.has_reference_clock' class="method"><span id='has_reference_clock.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.has_reference_clock' class='fnname'>has_reference_clock</a>() -&gt; bool</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/cortex_m/peripheral/syst.rs.html#114-117' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Checks if an external reference clock is available</p>
</div><h4 id='method.has_wrapped' class="method"><span id='has_wrapped.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.has_wrapped' class='fnname'>has_wrapped</a>(&amp;mut self) -&gt; bool</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/cortex_m/peripheral/syst.rs.html#123-125' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Checks if the counter wrapped (underflowed) since the last check</p>
<p><em>NOTE</em> This takes <code>&amp;mut self</code> because the read operation is side effectful and will clear
the bit of the read register.</p>
</div><h4 id='method.is_counter_enabled' class="method"><span id='is_counter_enabled.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.is_counter_enabled' class='fnname'>is_counter_enabled</a>(&amp;mut self) -&gt; bool</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/cortex_m/peripheral/syst.rs.html#131-133' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Checks if counter is enabled</p>
<p><em>NOTE</em> This takes <code>&amp;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><h4 id='method.is_interrupt_enabled' class="method"><span id='is_interrupt_enabled.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.is_interrupt_enabled' class='fnname'>is_interrupt_enabled</a>(&amp;mut self) -&gt; bool</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/cortex_m/peripheral/syst.rs.html#139-141' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Checks if SysTick interrupt is enabled</p>
<p><em>NOTE</em> This takes <code>&amp;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><h4 id='method.is_precise' class="method"><span id='is_precise.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.is_precise' class='fnname'>is_precise</a>() -&gt; bool</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/cortex_m/peripheral/syst.rs.html#148-151' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><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><h4 id='method.set_clock_source' class="method"><span id='set_clock_source.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.set_clock_source' class='fnname'>set_clock_source</a>(&amp;mut self, clk_source: <a class="enum" href="../../cortex_m/peripheral/syst/enum.SystClkSource.html" title="enum cortex_m::peripheral::syst::SystClkSource">SystClkSource</a>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/cortex_m/peripheral/syst.rs.html#154-159' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets clock source</p>
</div><h4 id='method.set_reload' class="method"><span id='set_reload.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.set_reload' class='fnname'>set_reload</a>(&amp;mut self, value: u32)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/cortex_m/peripheral/syst.rs.html#166-168' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><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></div><h3 id='impl-1' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="struct" href="../../cortex_m/peripheral/struct.SYST.html" title="struct cortex_m::peripheral::SYST">SYST</a></code><a href='#impl-1' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/cortex_m/peripheral/mod.rs.html#464-469' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.ptr' class="method"><span id='ptr.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.ptr' class='fnname'>ptr</a>() -&gt; *const <a class="struct" href="../../cortex_m/peripheral/syst/struct.RegisterBlock.html" title="struct cortex_m::peripheral::syst::RegisterBlock">RegisterBlock</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/cortex_m/peripheral/mod.rs.html#466-468' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a pointer to the register block</p>
</div></div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../cortex_m/peripheral/struct.SYST.html" title="struct cortex_m::peripheral::SYST">SYST</a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/cortex_m/peripheral/mod.rs.html#462' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Deref' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a> for <a class="struct" href="../../cortex_m/peripheral/struct.SYST.html" title="struct cortex_m::peripheral::SYST">SYST</a></code><a href='#impl-Deref' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/cortex_m/peripheral/mod.rs.html#471-477' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Target' class="type"><span id='Target.t' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#associatedtype.Target' class="type">Target</a> = <a class="struct" href="../../cortex_m/peripheral/syst/struct.RegisterBlock.html" title="struct cortex_m::peripheral::syst::RegisterBlock">RegisterBlock</a></code></span></h4>
<div class='docblock'><p>The resulting type after dereferencing.</p>
</div><h4 id='method.deref' class="method"><span id='deref.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#tymethod.deref' class='fnname'>deref</a>(&amp;self) -&gt; &amp;Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#associatedtype.Target" title="type core::ops::deref::Deref::Target">Target</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/cortex_m/peripheral/mod.rs.html#474-476' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Dereferences the value.</p>
</div></div></div><h2 id='synthetic-implementations' class='small-section-header'>Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a></h2><div id='synthetic-implementations-list'><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../cortex_m/peripheral/struct.SYST.html" title="struct cortex_m::peripheral::SYST">SYST</a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></div><h2 id='blanket-implementations' class='small-section-header'>Blanket Implementations<a href='#blanket-implementations' class='anchor'></a></h2><div id='blanket-implementations-list'><h3 id='impl-TryFrom' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a> for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;U&gt;,&nbsp;</span></code><a href='#impl-TryFrom' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#481-487' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Error' class="type"><span id='Error.t' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error' class="type">Error</a> = !</code></span></h4>
<div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>try_from</code>)</div></div><div class='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4 id='method.try_from' class="method"><span id='try_from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from' class='fnname'>try_from</a>(value: U) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/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/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt;&gt;::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#484-486' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>try_from</code>)</div></div><div class='docblock'><p>Performs the conversion.</p>
</div></div><h3 id='impl-From' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a> for T</code><a href='#impl-From' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#462-464' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.from' class="method"><span id='from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(t: T) -&gt; T</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#463' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
</div></div><h3 id='impl-TryInto' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a> for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;,&nbsp;</span></code><a href='#impl-TryInto' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#469-476' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Error-1' class="type"><span id='Error.t-1' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error' class="type">Error</a> = &lt;U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></span></h4>
<div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>try_from</code>)</div></div><div class='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4 id='method.try_into' class="method"><span id='try_into.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into' class='fnname'>try_into</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/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/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#473-475' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='stability'><div class='stab unstable'><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>try_from</code>)</div></div><div class='docblock'><p>Performs the conversion.</p>
</div></div><h3 id='impl-Into' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a> for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt;,&nbsp;</span></code><a href='#impl-Into' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#453-458' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.into' class="method"><span id='into.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into' class='fnname'>into</a>(self) -&gt; U</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#455-457' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
</div></div><h3 id='impl-Borrow' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a> for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></code><a href='#impl-Borrow' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#219-221' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.borrow' class="method"><span id='borrow.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow' class='fnname'>borrow</a>(&amp;self) -&gt; &amp;T</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#220' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
</div></div><h3 id='impl-BorrowMut' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a> for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></code><a href='#impl-BorrowMut' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#224-226' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.borrow_mut' class="method"><span id='borrow_mut.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut' class='fnname'>borrow_mut</a>(&amp;mut self) -&gt; &amp;mut T</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#225' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
</div></div><h3 id='impl-Any' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></code><a href='#impl-Any' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#114-116' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.get_type_id' class="method"><span id='get_type_id.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.get_type_id' class='fnname'>get_type_id</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#115' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='stability'><div class='stab unstable'><details><summary><span class=microscope>🔬</span> This is a nightly-only experimental API. (<code>get_type_id</code>)</summary><p>this method will likely be replaced by an associated static</p>
</details></div></div><div class='docblock'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.get_type_id">Read more</a></p>
</div></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd></kbd></dt><dd>Move up in search results</dd><dt><kbd></kbd></dt><dd>Move down in search results</dd><dt><kbd></kbd></dt><dd>Switch tab</dd><dt><kbd>&#9166;</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "cortex_m";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>