mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-11-29 23:14:34 +01:00
35 lines
17 KiB
HTML
35 lines
17 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_time - 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_time" 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_time/index.html">rtic_<wbr>time</a><span class="version">2.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="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.delay">delay</a></li><li><a href="#tymethod.delay_until">delay_until</a></li><li><a href="#tymethod.now">now</a></li><li><a href="#tymethod.timeout_after">timeout_after</a></li><li><a href="#tymethod.timeout_at">timeout_at</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>time</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_time</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_time/lib.rs.html#29-64">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_time::Monotonic::Duration">Duration</a>, Output = Self::<a class="associatedtype" href="trait.Monotonic.html#associatedtype.Instant" title="type rtic_time::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_time::Monotonic::Duration">Duration</a>, Output = Self::<a class="associatedtype" href="trait.Monotonic.html#associatedtype.Instant" title="type rtic_time::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_time::Monotonic::Instant">Instant</a>, Output = Self::<a class="associatedtype" href="trait.Monotonic.html#associatedtype.Duration" title="type rtic_time::Monotonic::Duration">Duration</a>>;
|
||
|
|
type <a href="#associatedtype.Duration" class="associatedtype">Duration</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>;
|
||
|
|
|
||
|
|
// Required methods
|
||
|
|
fn <a href="#tymethod.now" class="fn">now</a>() -> Self::<a class="associatedtype" href="trait.Monotonic.html#associatedtype.Instant" title="type rtic_time::Monotonic::Instant">Instant</a>;
|
||
|
|
<span class="item-spacer"></span> async fn <a href="#tymethod.delay" class="fn">delay</a>(duration: Self::<a class="associatedtype" href="trait.Monotonic.html#associatedtype.Duration" title="type rtic_time::Monotonic::Duration">Duration</a>);
|
||
|
|
<span class="item-spacer"></span> async fn <a href="#tymethod.delay_until" class="fn">delay_until</a>(instant: Self::<a class="associatedtype" href="trait.Monotonic.html#associatedtype.Instant" title="type rtic_time::Monotonic::Instant">Instant</a>);
|
||
|
|
<span class="item-spacer"></span> async fn <a href="#tymethod.timeout_at" class="fn">timeout_at</a><F: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>>(
|
||
|
|
instant: Self::<a class="associatedtype" href="trait.Monotonic.html#associatedtype.Instant" title="type rtic_time::Monotonic::Instant">Instant</a>,
|
||
|
|
future: F,
|
||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><F::<a class="associatedtype" href="https://doc.rust-lang.org/1.82.0/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>, <a class="struct" href="struct.TimeoutError.html" title="struct rtic_time::TimeoutError">TimeoutError</a>>;
|
||
|
|
<span class="item-spacer"></span> async fn <a href="#tymethod.timeout_after" class="fn">timeout_after</a><F: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>>(
|
||
|
|
duration: Self::<a class="associatedtype" href="trait.Monotonic.html#associatedtype.Duration" title="type rtic_time::Monotonic::Duration">Duration</a>,
|
||
|
|
future: F,
|
||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><F::<a class="associatedtype" href="https://doc.rust-lang.org/1.82.0/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>, <a class="struct" href="struct.TimeoutError.html" title="struct rtic_time::TimeoutError">TimeoutError</a>>;
|
||
|
|
}</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_time/lib.rs.html#33-37">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_time::Monotonic::Duration">Duration</a>, Output = Self::<a class="associatedtype" href="trait.Monotonic.html#associatedtype.Instant" title="type rtic_time::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_time::Monotonic::Duration">Duration</a>, Output = Self::<a class="associatedtype" href="trait.Monotonic.html#associatedtype.Instant" title="type rtic_time::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_time::Monotonic::Instant">Instant</a>, Output = Self::<a class="associatedtype" href="trait.Monotonic.html#associatedtype.Duration" title="type rtic_time::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_time/lib.rs.html#42">source</a><h4 class="code-header">type <a href="#associatedtype.Duration" class="associatedtype">Duration</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></h4></section></summary><div class="docblock"><p>The type for duration, defining a 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="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_time/lib.rs.html#45">source</a><h4 class="code-header">fn <a href="#tymethod.now" class="fn">now</a>() -> Self::<a class="associatedtype" href="trait.Monotonic.html#associatedtype.Instant" title="type rtic_time::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.delay" class="method"><a class="src rightside" href="../src/rtic_time/lib.rs.html#48">source</a><h4 class="code-header">async fn <a href="#tymethod.delay" class="fn">delay</a>(duration: Self::<a class="associatedtype" href="trait.Monotonic.html#associatedtype.Duration" title="type rtic_time::Monotonic::Duration">Duration</a>)</h4></section></summary><div class="docblock"><p>Delay for some duration of time.</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.delay_until" class="method"><a class="src rightside" href="../src/rtic_time/lib.rs.html#51">source</a><h4 class="code-header">async fn <a href="#tymethod.delay_until" class="fn">delay_until</a>(instant: Self::<a class="associatedtype" href="trait.Monotonic.html#associatedtype.Instant" title="type rtic_time::Monotonic::Instant">Instant</a>)</h4></section></summary><div class="docblock"><p>Delay to some specific time instant.</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.timeout_at" class="method"><a class="src rightside" href="../src/rtic_time/lib.rs.html#54-57">source</a><h4 class="code-header">async fn <a href="#tymethod.timeout_at" class="fn">timeout_at</a><F: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>>(
|
||
|
|
instant: Self::<a class="associatedtype" href="trait.Monotonic.html#associatedtype.Instant" title="type rtic_time::Monotonic::Instant">Instant</a>,
|
||
|
|
future: F,
|
||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><F::<a class="associatedtype" href="https://doc.rust-lang.org/1.82.0/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>, <a class="struct" href="struct.TimeoutError.html" title="struct rtic_time::TimeoutError">TimeoutError</a>></h4></section></summary><div class="docblock"><p>Timeout at a specific time.</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.timeout_after" class="method"><a class="src rightside" href="../src/rtic_time/lib.rs.html#60-63">source</a><h4 class="code-header">async fn <a href="#tymethod.timeout_after" class="fn">timeout_after</a><F: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>>(
|
||
|
|
duration: Self::<a class="associatedtype" href="trait.Monotonic.html#associatedtype.Duration" title="type rtic_time::Monotonic::Duration">Duration</a>,
|
||
|
|
future: F,
|
||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><F::<a class="associatedtype" href="https://doc.rust-lang.org/1.82.0/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>, <a class="struct" href="struct.TimeoutError.html" title="struct rtic_time::TimeoutError">TimeoutError</a>></h4></section></summary><div class="docblock"><p>Timeout after a specific duration.</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"><details class="toggle implementors-toggle"><summary><section id="impl-Monotonic-for-T" class="impl"><a class="src rightside" href="../src/rtic_time/monotonic/timer_queue_based_monotonic.rs.html#24-57">source</a><a href="#impl-Monotonic-for-T" class="anchor">§</a><h3 class="code-header">impl<T: <a class="trait" href="monotonic/trait.TimerQueueBasedMonotonic.html" title="trait rtic_time::monotonic::TimerQueueBasedMonotonic">TimerQueueBasedMonotonic</a>> <a class="trait" href="trait.Monotonic.html" title="trait rtic_time::Monotonic">Monotonic</a> for T</h3></section></summary><div class="impl-items"><section id="associatedtype.Instant-1" class="associatedtype trait-impl"><a class="src rightside" href="../src/rtic_time/monotonic/timer_queue_based_monotonic.rs.html#25">source</a><a href="#associatedtype.Instant-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Instant" class="associatedtype">Instant</a> = <T as <a class="trait" href="monotonic/trait.TimerQueueBasedMonotonic.html" title="trait rtic_time::monotonic::TimerQueueBasedMonotonic">TimerQueueBasedMonotonic</a>>::<a class="associatedtype" href="monotonic/trait.TimerQueueBasedMonotonic.html#associatedtype.Instant" title="type rtic_time::monotonic::TimerQueueBasedMonotonic::Instant">Instant</a></h4></section><section id="associatedtype.Duration-1" class="associatedtype trait-impl"><a class="src rightside" href="../src/rtic_time/monotonic/timer_queue_based_monotonic.rs.html#26">source</a><a href="#associatedtype.Duration-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Duration" class="associatedtype">Duration</a> = <T as <a class="trait" href="monotonic/trait.TimerQueueBasedMonotonic.html" title="trait rtic_time::monotonic::TimerQueueBasedMonotonic">TimerQueueBasedMonotonic</a>>::<a class="associatedtype" href="monotonic/trait.TimerQueueBasedMonotonic.html#associatedtype.Duration" title="type rtic_time::monotonic::TimerQueueBasedMonotonic::Duration">Duration</a></h4></section></div></details></div><script src="../trait.impl/rtic_time/trait.Monotonic.js" async></script></section></div></main></body></html>
|