rtic/2/api/rtic_time/timer_queue/trait.TimerQueueBackend.html
2024-12-06 13:35:18 +00:00

33 lines
No EOL
12 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="A backend definition for a monotonic clock/counter."><title>TimerQueueBackend in rtic_time::timer_queue - 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="rtic_time" 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 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><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Timer<wbr>Queue<wbr>Backend</a></h2><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Ticks" title="Ticks">Ticks</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.clear_compare_flag" title="clear_compare_flag">clear_compare_flag</a></li><li><a href="#tymethod.now" title="now">now</a></li><li><a href="#tymethod.pend_interrupt" title="pend_interrupt">pend_interrupt</a></li><li><a href="#tymethod.set_compare" title="set_compare">set_compare</a></li><li><a href="#tymethod.timer_queue" title="timer_queue">timer_queue</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.disable_timer" title="disable_timer">disable_timer</a></li><li><a href="#method.enable_timer" title="enable_timer">enable_timer</a></li><li><a href="#method.on_interrupt" title="on_interrupt">on_interrupt</a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In rtic_<wbr>time::<wbr>timer_<wbr>queue</a></h2></div></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"><span class="rustdoc-breadcrumbs"><a href="../index.html">rtic_time</a>::<wbr><a href="index.html">timer_queue</a></span><h1>Trait <span class="trait">TimerQueueBackend</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/rtic_time/timer_queue/backend.rs.html#4-44">source</a> </span></div><pre class="rust item-decl"><code>pub trait TimerQueueBackend: '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> {
type <a href="#associatedtype.Ticks" class="associatedtype">Ticks</a>: <a class="trait" href="trait.TimerQueueTicks.html" title="trait rtic_time::timer_queue::TimerQueueTicks">TimerQueueTicks</a>;
// Required methods
fn <a href="#tymethod.now" class="fn">now</a>() -&gt; Self::<a class="associatedtype" href="trait.TimerQueueBackend.html#associatedtype.Ticks" title="type rtic_time::timer_queue::TimerQueueBackend::Ticks">Ticks</a>;
<span class="item-spacer"></span> fn <a href="#tymethod.set_compare" class="fn">set_compare</a>(instant: Self::<a class="associatedtype" href="trait.TimerQueueBackend.html#associatedtype.Ticks" title="type rtic_time::timer_queue::TimerQueueBackend::Ticks">Ticks</a>);
<span class="item-spacer"></span> fn <a href="#tymethod.clear_compare_flag" class="fn">clear_compare_flag</a>();
<span class="item-spacer"></span> fn <a href="#tymethod.pend_interrupt" class="fn">pend_interrupt</a>();
<span class="item-spacer"></span> fn <a href="#tymethod.timer_queue" class="fn">timer_queue</a>() -&gt; &amp;'static <a class="struct" href="struct.TimerQueue.html" title="struct rtic_time::timer_queue::TimerQueue">TimerQueue</a>&lt;Self&gt;;
// Provided methods
fn <a href="#method.on_interrupt" class="fn">on_interrupt</a>() { ... }
<span class="item-spacer"></span> fn <a href="#method.enable_timer" class="fn">enable_timer</a>() { ... }
<span class="item-spacer"></span> fn <a href="#method.disable_timer" class="fn">disable_timer</a>() { ... }
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A backend definition for a monotonic clock/counter.</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.Ticks" class="method"><a class="src rightside" href="../../src/rtic_time/timer_queue/backend.rs.html#6">source</a><h4 class="code-header">type <a href="#associatedtype.Ticks" class="associatedtype">Ticks</a>: <a class="trait" href="trait.TimerQueueTicks.html" title="trait rtic_time::timer_queue::TimerQueueTicks">TimerQueueTicks</a></h4></section></summary><div class="docblock"><p>The type for ticks.</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/timer_queue/backend.rs.html#9">source</a><h4 class="code-header">fn <a href="#tymethod.now" class="fn">now</a>() -&gt; Self::<a class="associatedtype" href="trait.TimerQueueBackend.html#associatedtype.Ticks" title="type rtic_time::timer_queue::TimerQueueBackend::Ticks">Ticks</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_time/timer_queue/backend.rs.html#15">source</a><h4 class="code-header">fn <a href="#tymethod.set_compare" class="fn">set_compare</a>(instant: Self::<a class="associatedtype" href="trait.TimerQueueBackend.html#associatedtype.Ticks" title="type rtic_time::timer_queue::TimerQueueBackend::Ticks">Ticks</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_time/timer_queue/backend.rs.html#18">source</a><h4 class="code-header">fn <a href="#tymethod.clear_compare_flag" class="fn">clear_compare_flag</a>()</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.pend_interrupt" class="method"><a class="src rightside" href="../../src/rtic_time/timer_queue/backend.rs.html#21">source</a><h4 class="code-header">fn <a href="#tymethod.pend_interrupt" class="fn">pend_interrupt</a>()</h4></section></summary><div class="docblock"><p>Pend the timers interrupt.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.timer_queue" class="method"><a class="src rightside" href="../../src/rtic_time/timer_queue/backend.rs.html#43">source</a><h4 class="code-header">fn <a href="#tymethod.timer_queue" class="fn">timer_queue</a>() -&gt; &amp;'static <a class="struct" href="struct.TimerQueue.html" title="struct rtic_time::timer_queue::TimerQueue">TimerQueue</a>&lt;Self&gt;</h4></section></summary><div class="docblock"><p>Returns a reference to the underlying timer queue.</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_time/timer_queue/backend.rs.html#24">source</a><h4 class="code-header">fn <a href="#method.on_interrupt" class="fn">on_interrupt</a>()</h4></section></summary><div class="docblock"><p>Optional. Runs on interrupt before any timer queue handling.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.enable_timer" class="method"><a class="src rightside" href="../../src/rtic_time/timer_queue/backend.rs.html#32">source</a><h4 class="code-header">fn <a href="#method.enable_timer" class="fn">enable_timer</a>()</h4></section></summary><div class="docblock"><p>Optional. This is used to save power, this is called when the timer queue is not empty.</p>
<p>Enabling and disabling the monotonic needs to propagate to <code>now</code> so that an instant
based of <code>now()</code> is still valid.</p>
<p>NOTE: This may be called more than once.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.disable_timer" class="method"><a class="src rightside" href="../../src/rtic_time/timer_queue/backend.rs.html#40">source</a><h4 class="code-header">fn <a href="#method.disable_timer" class="fn">disable_timer</a>()</h4></section></summary><div class="docblock"><p>Optional. This is used to save power, this is called when the timer queue is empty.</p>
<p>Enabling and disabling the monotonic needs to propagate to <code>now</code> so that an instant
based of <code>now()</code> is still valid.</p>
<p>NOTE: This may be called more than once.</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.83.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_time/timer_queue/backend/trait.TimerQueueBackend.js" async></script></section></div></main></body></html>