mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-11-26 05:29:38 +01:00
47 lines
16 KiB
HTML
47 lines
16 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="A monotonic clock / counter definition."><title>Monotonic in rtic_monotonic - 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="rtic_monotonic" 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 trait"><!--[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="../rtic_monotonic/index.html">rtic_<wbr>monotonic</a><span class="version">1.0.0</span></h2></div><h2 class="location"><a href="#">Monotonic</a></h2><div class="sidebar-elems"><section><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Duration">Duration</a></li><li><a href="#associatedtype.Instant">Instant</a></li></ul><h3><a href="#provided-associated-consts">Provided Associated Constants</a></h3><ul class="block"><li><a href="#associatedconstant.DISABLE_INTERRUPT_ON_EMPTY_QUEUE">DISABLE_INTERRUPT_ON_EMPTY_QUEUE</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.clear_compare_flag">clear_compare_flag</a></li><li><a href="#tymethod.now">now</a></li><li><a href="#tymethod.reset">reset</a></li><li><a href="#tymethod.set_compare">set_compare</a></li><li><a href="#tymethod.zero">zero</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.disable_timer">disable_timer</a></li><li><a href="#method.enable_timer">enable_timer</a></li><li><a href="#method.on_interrupt">on_interrupt</a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In crate rtic_<wbr>monotonic</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Trait <a href="index.html">rtic_monotonic</a>::<wbr><a class="trait" href="#">Monotonic</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../src/rtic_monotonic/lib.rs.html#25-85">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait Monotonic {
|
||
|
|
type <a href="#associatedtype.Instant" class="associatedtype">Instant</a>: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a> + <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> + <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/ops/arith/trait.Add.html" title="trait core::ops::arith::Add">Add</a><Self::<a class="associatedtype" href="trait.Monotonic.html#associatedtype.Duration" title="type rtic_monotonic::Monotonic::Duration">Duration</a>, Output = Self::<a class="associatedtype" href="trait.Monotonic.html#associatedtype.Instant" title="type rtic_monotonic::Monotonic::Instant">Instant</a>> + <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/ops/arith/trait.Sub.html" title="trait core::ops::arith::Sub">Sub</a><Self::<a class="associatedtype" href="trait.Monotonic.html#associatedtype.Duration" title="type rtic_monotonic::Monotonic::Duration">Duration</a>, Output = Self::<a class="associatedtype" href="trait.Monotonic.html#associatedtype.Instant" title="type rtic_monotonic::Monotonic::Instant">Instant</a>> + <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/ops/arith/trait.Sub.html" title="trait core::ops::arith::Sub">Sub</a><Self::<a class="associatedtype" href="trait.Monotonic.html#associatedtype.Instant" title="type rtic_monotonic::Monotonic::Instant">Instant</a>, Output = Self::<a class="associatedtype" href="trait.Monotonic.html#associatedtype.Duration" title="type rtic_monotonic::Monotonic::Duration">Duration</a>>;
|
||
|
|
type <a href="#associatedtype.Duration" class="associatedtype">Duration</a>;
|
||
|
|
|
||
|
|
const <a href="#associatedconstant.DISABLE_INTERRUPT_ON_EMPTY_QUEUE" class="constant">DISABLE_INTERRUPT_ON_EMPTY_QUEUE</a>: <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.bool.html">bool</a> = true;
|
||
|
|
|
||
|
|
// Required methods
|
||
|
|
fn <a href="#tymethod.now" class="fn">now</a>(&mut self) -> Self::<a class="associatedtype" href="trait.Monotonic.html#associatedtype.Instant" title="type rtic_monotonic::Monotonic::Instant">Instant</a>;
|
||
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.set_compare" class="fn">set_compare</a>(&mut self, instant: Self::<a class="associatedtype" href="trait.Monotonic.html#associatedtype.Instant" title="type rtic_monotonic::Monotonic::Instant">Instant</a>);
|
||
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.clear_compare_flag" class="fn">clear_compare_flag</a>(&mut self);
|
||
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.zero" class="fn">zero</a>() -> Self::<a class="associatedtype" href="trait.Monotonic.html#associatedtype.Instant" title="type rtic_monotonic::Monotonic::Instant">Instant</a>;
|
||
|
|
<span class="item-spacer"></span> unsafe fn <a href="#tymethod.reset" class="fn">reset</a>(&mut self);
|
||
|
|
|
||
|
|
// Provided methods
|
||
|
|
fn <a href="#method.on_interrupt" class="fn">on_interrupt</a>(&mut self) { ... }
|
||
|
|
<span class="item-spacer"></span> fn <a href="#method.enable_timer" class="fn">enable_timer</a>(&mut self) { ... }
|
||
|
|
<span class="item-spacer"></span> fn <a href="#method.disable_timer" class="fn">disable_timer</a>(&mut self) { ... }
|
||
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><h2 id="a-monotonic-clock--counter-definition"><a class="doc-anchor" href="#a-monotonic-clock--counter-definition">§</a>A monotonic clock / counter definition.</h2><h3 id="correctness"><a class="doc-anchor" href="#correctness">§</a>Correctness</h3>
|
||
|
|
<p>The trait enforces that proper time-math is implemented between <code>Instant</code> and <code>Duration</code>. This
|
||
|
|
is a requirement on the time library that the user chooses to use.</p>
|
||
|
|
</div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedtype.Instant" class="method"><a class="src rightside" href="../src/rtic_monotonic/lib.rs.html#35-39">source</a><h4 class="code-header">type <a href="#associatedtype.Instant" class="associatedtype">Instant</a>: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a> + <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> + <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/ops/arith/trait.Add.html" title="trait core::ops::arith::Add">Add</a><Self::<a class="associatedtype" href="trait.Monotonic.html#associatedtype.Duration" title="type rtic_monotonic::Monotonic::Duration">Duration</a>, Output = Self::<a class="associatedtype" href="trait.Monotonic.html#associatedtype.Instant" title="type rtic_monotonic::Monotonic::Instant">Instant</a>> + <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/ops/arith/trait.Sub.html" title="trait core::ops::arith::Sub">Sub</a><Self::<a class="associatedtype" href="trait.Monotonic.html#associatedtype.Duration" title="type rtic_monotonic::Monotonic::Duration">Duration</a>, Output = Self::<a class="associatedtype" href="trait.Monotonic.html#associatedtype.Instant" title="type rtic_monotonic::Monotonic::Instant">Instant</a>> + <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/ops/arith/trait.Sub.html" title="trait core::ops::arith::Sub">Sub</a><Self::<a class="associatedtype" href="trait.Monotonic.html#associatedtype.Instant" title="type rtic_monotonic::Monotonic::Instant">Instant</a>, Output = Self::<a class="associatedtype" href="trait.Monotonic.html#associatedtype.Duration" title="type rtic_monotonic::Monotonic::Duration">Duration</a>></h4></section></summary><div class="docblock"><p>The type for instant, defining an instant in time.</p>
|
||
|
|
<p><strong>Note:</strong> In all APIs in RTIC that use instants from this monotonic, this type will be used.</p>
|
||
|
|
</div></details><details class="toggle" open><summary><section id="associatedtype.Duration" class="method"><a class="src rightside" href="../src/rtic_monotonic/lib.rs.html#44">source</a><h4 class="code-header">type <a href="#associatedtype.Duration" class="associatedtype">Duration</a></h4></section></summary><div class="docblock"><p>The type for duration, defining an duration of time.</p>
|
||
|
|
<p><strong>Note:</strong> In all APIs in RTIC that use duration from this monotonic, this type will be used.</p>
|
||
|
|
</div></details></div><h2 id="provided-associated-consts" class="section-header">Provided Associated Constants<a href="#provided-associated-consts" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedconstant.DISABLE_INTERRUPT_ON_EMPTY_QUEUE" class="method"><a class="src rightside" href="../src/rtic_monotonic/lib.rs.html#30">source</a><h4 class="code-header">const <a href="#associatedconstant.DISABLE_INTERRUPT_ON_EMPTY_QUEUE" class="constant">DISABLE_INTERRUPT_ON_EMPTY_QUEUE</a>: <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.bool.html">bool</a> = true</h4></section></summary><div class="docblock"><p>This tells RTIC if it should disable the interrupt bound to the monotonic if there are no
|
||
|
|
scheduled tasks. One may want to set this to <code>false</code> if one is using the <code>on_interrupt</code>
|
||
|
|
method to perform housekeeping and need overflow interrupts to happen, such as when
|
||
|
|
extending a 16 bit timer to 32/64 bits, even if there are no scheduled tasks.</p>
|
||
|
|
</div></details></div><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.now" class="method"><a class="src rightside" href="../src/rtic_monotonic/lib.rs.html#47">source</a><h4 class="code-header">fn <a href="#tymethod.now" class="fn">now</a>(&mut self) -> Self::<a class="associatedtype" href="trait.Monotonic.html#associatedtype.Instant" title="type rtic_monotonic::Monotonic::Instant">Instant</a></h4></section></summary><div class="docblock"><p>Get the current time.</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.set_compare" class="method"><a class="src rightside" href="../src/rtic_monotonic/lib.rs.html#53">source</a><h4 class="code-header">fn <a href="#tymethod.set_compare" class="fn">set_compare</a>(&mut self, instant: Self::<a class="associatedtype" href="trait.Monotonic.html#associatedtype.Instant" title="type rtic_monotonic::Monotonic::Instant">Instant</a>)</h4></section></summary><div class="docblock"><p>Set the compare value of the timer interrupt.</p>
|
||
|
|
<p><strong>Note:</strong> This method does not need to handle race conditions of the monotonic, the timer
|
||
|
|
queue in RTIC checks this.</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.clear_compare_flag" class="method"><a class="src rightside" href="../src/rtic_monotonic/lib.rs.html#56">source</a><h4 class="code-header">fn <a href="#tymethod.clear_compare_flag" class="fn">clear_compare_flag</a>(&mut self)</h4></section></summary><div class="docblock"><p>Clear the compare interrupt flag.</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.zero" class="method"><a class="src rightside" href="../src/rtic_monotonic/lib.rs.html#59">source</a><h4 class="code-header">fn <a href="#tymethod.zero" class="fn">zero</a>() -> Self::<a class="associatedtype" href="trait.Monotonic.html#associatedtype.Instant" title="type rtic_monotonic::Monotonic::Instant">Instant</a></h4></section></summary><div class="docblock"><p>The time at time zero. Used by RTIC before the monotonic has been initialized.</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.reset" class="method"><a class="src rightside" href="../src/rtic_monotonic/lib.rs.html#71">source</a><h4 class="code-header">unsafe fn <a href="#tymethod.reset" class="fn">reset</a>(&mut self)</h4></section></summary><div class="docblock"><p>Optionally resets the counter to <em>zero</em> for a fixed baseline in a system.</p>
|
||
|
|
<p>This method will be called <em>exactly once</em> by the RTIC runtime after <code>#[init]</code> returns and
|
||
|
|
before tasks start.</p>
|
||
|
|
<h5 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h5><h6 id="correctness-1"><a class="doc-anchor" href="#correctness-1">§</a>Correctness</h6>
|
||
|
|
<p>The user may not call this method.</p>
|
||
|
|
</div></details></div><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.on_interrupt" class="method"><a class="src rightside" href="../src/rtic_monotonic/lib.rs.html#76">source</a><h4 class="code-header">fn <a href="#method.on_interrupt" class="fn">on_interrupt</a>(&mut self)</h4></section></summary><div class="docblock"><p>Optional. Commonly used for performing housekeeping of a timer when it has been extended,
|
||
|
|
e.g. a 16 bit timer extended to 32/64 bits. This will be called at the end of the interrupt
|
||
|
|
handler after all other operations have finished.</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.enable_timer" class="method"><a class="src rightside" href="../src/rtic_monotonic/lib.rs.html#80">source</a><h4 class="code-header">fn <a href="#method.enable_timer" class="fn">enable_timer</a>(&mut self)</h4></section></summary><div class="docblock"><p>Optional. This is used to save power, this is called when the Monotonic interrupt is
|
||
|
|
enabled.</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.disable_timer" class="method"><a class="src rightside" href="../src/rtic_monotonic/lib.rs.html#84">source</a><h4 class="code-header">fn <a href="#method.disable_timer" class="fn">disable_timer</a>(&mut self)</h4></section></summary><div class="docblock"><p>Optional. This is used to save power, this is called when the Monotonic interrupt is
|
||
|
|
disabled.</p>
|
||
|
|
</div></details></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.82.0/reference/items/traits.html#object-safety">object safe</a>.</div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../trait.impl/rtic_monotonic/trait.Monotonic.js" async></script></section></div></main></body></html>
|