mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-12-26 11:59:33 +01:00
11 lines
11 KiB
HTML
11 lines
11 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` that is backed by the `TimerQueue`."><title>TimerQueueBasedMonotonic in rtic_monotonics - 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_monotonics" 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_monotonics/index.html">rtic_<wbr>monotonics</a><span class="version">2.0.3</span></h2></div><h2 class="location"><a href="#">Timer<wbr>Queue<wbr>Based<wbr>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.Backend">Backend</a></li><li><a href="#associatedtype.Duration">Duration</a></li><li><a href="#associatedtype.Instant">Instant</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In crate rtic_<wbr>monotonics</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_monotonics</a>::<wbr><a class="trait" href="#">TimerQueueBasedMonotonic</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/monotonic/timer_queue_based_monotonic.rs.html#6">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait TimerQueueBasedMonotonic {
|
||
|
|
type <a href="#associatedtype.Backend" class="associatedtype">Backend</a>: <a class="trait" href="trait.TimerQueueBackend.html" title="trait rtic_monotonics::TimerQueueBackend">TimerQueueBackend</a>;
|
||
|
|
type <a href="#associatedtype.Instant" class="associatedtype">Instant</a>: <a class="trait" href="../rtic_time/monotonic/timer_queue_based_monotonic/trait.TimerQueueBasedInstant.html" title="trait rtic_time::monotonic::timer_queue_based_monotonic::TimerQueueBasedInstant">TimerQueueBasedInstant</a><Ticks = <Self::<a class="associatedtype" href="trait.TimerQueueBasedMonotonic.html#associatedtype.Backend" title="type rtic_monotonics::TimerQueueBasedMonotonic::Backend">Backend</a> as <a class="trait" href="trait.TimerQueueBackend.html" title="trait rtic_monotonics::TimerQueueBackend">TimerQueueBackend</a>>::<a class="associatedtype" href="trait.TimerQueueBackend.html#associatedtype.Ticks" title="type rtic_monotonics::TimerQueueBackend::Ticks">Ticks</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.TimerQueueBasedMonotonic.html#associatedtype.Duration" title="type rtic_monotonics::TimerQueueBasedMonotonic::Duration">Duration</a>, Output = Self::<a class="associatedtype" href="trait.TimerQueueBasedMonotonic.html#associatedtype.Instant" title="type rtic_monotonics::TimerQueueBasedMonotonic::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.TimerQueueBasedMonotonic.html#associatedtype.Duration" title="type rtic_monotonics::TimerQueueBasedMonotonic::Duration">Duration</a>, Output = Self::<a class="associatedtype" href="trait.TimerQueueBasedMonotonic.html#associatedtype.Instant" title="type rtic_monotonics::TimerQueueBasedMonotonic::Instant">Instant</a>, Output = Self::<a class="associatedtype" href="trait.TimerQueueBasedMonotonic.html#associatedtype.Duration" title="type rtic_monotonics::TimerQueueBasedMonotonic::Duration">Duration</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>;
|
||
|
|
type <a href="#associatedtype.Duration" class="associatedtype">Duration</a>: <a class="trait" href="../rtic_time/monotonic/timer_queue_based_monotonic/trait.TimerQueueBasedDuration.html" title="trait rtic_time::monotonic::timer_queue_based_monotonic::TimerQueueBasedDuration">TimerQueueBasedDuration</a><Ticks = <Self::<a class="associatedtype" href="trait.TimerQueueBasedMonotonic.html#associatedtype.Backend" title="type rtic_monotonics::TimerQueueBasedMonotonic::Backend">Backend</a> as <a class="trait" href="trait.TimerQueueBackend.html" title="trait rtic_monotonics::TimerQueueBackend">TimerQueueBackend</a>>::<a class="associatedtype" href="trait.TimerQueueBackend.html#associatedtype.Ticks" title="type rtic_monotonics::TimerQueueBackend::Ticks">Ticks</a>>;
|
||
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A <a href="trait.Monotonic.html" title="trait rtic_monotonics::Monotonic"><code>Monotonic</code></a> that is backed by the <a href="../rtic_time/timer_queue/struct.TimerQueue.html" title="struct rtic_time::timer_queue::TimerQueue"><code>TimerQueue</code></a>.</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.Backend" class="method"><a class="src rightside" href="../src/rtic_time/monotonic/timer_queue_based_monotonic.rs.html#8">source</a><h4 class="code-header">type <a href="#associatedtype.Backend" class="associatedtype">Backend</a>: <a class="trait" href="trait.TimerQueueBackend.html" title="trait rtic_monotonics::TimerQueueBackend">TimerQueueBackend</a></h4></section></summary><div class="docblock"><p>The backend for the timer queue</p>
|
||
|
|
</div></details><details class="toggle" open><summary><section id="associatedtype.Instant" class="method"><a class="src rightside" href="../src/rtic_time/monotonic/timer_queue_based_monotonic.rs.html#13-16">source</a><h4 class="code-header">type <a href="#associatedtype.Instant" class="associatedtype">Instant</a>: <a class="trait" href="../rtic_time/monotonic/timer_queue_based_monotonic/trait.TimerQueueBasedInstant.html" title="trait rtic_time::monotonic::timer_queue_based_monotonic::TimerQueueBasedInstant">TimerQueueBasedInstant</a><Ticks = <Self::<a class="associatedtype" href="trait.TimerQueueBasedMonotonic.html#associatedtype.Backend" title="type rtic_monotonics::TimerQueueBasedMonotonic::Backend">Backend</a> as <a class="trait" href="trait.TimerQueueBackend.html" title="trait rtic_monotonics::TimerQueueBackend">TimerQueueBackend</a>>::<a class="associatedtype" href="trait.TimerQueueBackend.html#associatedtype.Ticks" title="type rtic_monotonics::TimerQueueBackend::Ticks">Ticks</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.TimerQueueBasedMonotonic.html#associatedtype.Duration" title="type rtic_monotonics::TimerQueueBasedMonotonic::Duration">Duration</a>, Output = Self::<a class="associatedtype" href="trait.TimerQueueBasedMonotonic.html#associatedtype.Instant" title="type rtic_monotonics::TimerQueueBasedMonotonic::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.TimerQueueBasedMonotonic.html#associatedtype.Duration" title="type rtic_monotonics::TimerQueueBasedMonotonic::Duration">Duration</a>, Output = Self::<a class="associatedtype" href="trait.TimerQueueBasedMonotonic.html#associatedtype.Instant" title="type rtic_monotonics::TimerQueueBasedMonotonic::Instant">Instant</a>, Output = Self::<a class="associatedtype" href="trait.TimerQueueBasedMonotonic.html#associatedtype.Duration" title="type rtic_monotonics::TimerQueueBasedMonotonic::Duration">Duration</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></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/monotonic/timer_queue_based_monotonic.rs.html#21">source</a><h4 class="code-header">type <a href="#associatedtype.Duration" class="associatedtype">Duration</a>: <a class="trait" href="../rtic_time/monotonic/timer_queue_based_monotonic/trait.TimerQueueBasedDuration.html" title="trait rtic_time::monotonic::timer_queue_based_monotonic::TimerQueueBasedDuration">TimerQueueBasedDuration</a><Ticks = <Self::<a class="associatedtype" href="trait.TimerQueueBasedMonotonic.html#associatedtype.Backend" title="type rtic_monotonics::TimerQueueBasedMonotonic::Backend">Backend</a> as <a class="trait" href="trait.TimerQueueBackend.html" title="trait rtic_monotonics::TimerQueueBackend">TimerQueueBackend</a>>::<a class="associatedtype" href="trait.TimerQueueBackend.html#associatedtype.Ticks" title="type rtic_monotonics::TimerQueueBackend::Ticks">Ticks</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="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../trait.impl/rtic_time/monotonic/timer_queue_based_monotonic/trait.TimerQueueBasedMonotonic.js" async></script></section></div></main></body></html>
|