mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-11-29 23:14:34 +01:00
22 lines
12 KiB
HTML
22 lines
12 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="The ticks of a timer."><title>TimerQueueTicks 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-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="#">Timer<wbr>Queue<wbr>Ticks</a></h2><div class="sidebar-elems"><section><h3><a href="#required-associated-consts">Required Associated Constants</a></h3><ul class="block"><li><a href="#associatedconstant.ONE_TICK">ONE_TICK</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.compare">compare</a></li><li><a href="#tymethod.wrapping_add">wrapping_add</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.is_at_least">is_at_least</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-TimerQueueTicks-for-u32">u32</a></li><li><a href="#impl-TimerQueueTicks-for-u64">u64</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 rtic_<wbr>time::<wbr>timer_<wbr>queue</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 href="index.html">timer_queue</a>::<wbr><a class="trait" href="#">TimerQueueTicks</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/timer_queue/tick_type.rs.html#4-28">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait TimerQueueTicks:
|
||
|
|
<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/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a>
|
||
|
|
+ <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> {
|
||
|
|
const <a href="#associatedconstant.ONE_TICK" class="constant">ONE_TICK</a>: Self;
|
||
|
|
|
||
|
|
// Required methods
|
||
|
|
fn <a href="#tymethod.compare" class="fn">compare</a>(self, other: Self) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a>;
|
||
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.wrapping_add" class="fn">wrapping_add</a>(self, other: Self) -> Self;
|
||
|
|
|
||
|
|
// Provided method
|
||
|
|
fn <a href="#method.is_at_least" class="fn">is_at_least</a>(self, other: Self) -> <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.bool.html">bool</a> { ... }
|
||
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The ticks of a timer.</p>
|
||
|
|
</div></details><h2 id="required-associated-consts" class="section-header">Required Associated Constants<a href="#required-associated-consts" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedconstant.ONE_TICK" class="method"><a class="src rightside" href="../../src/rtic_time/timer_queue/tick_type.rs.html#6">source</a><h4 class="code-header">const <a href="#associatedconstant.ONE_TICK" class="constant">ONE_TICK</a>: Self</h4></section></summary><div class="docblock"><p>Represents a single tick.</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.compare" class="method"><a class="src rightside" href="../../src/rtic_time/timer_queue/tick_type.rs.html#12">source</a><h4 class="code-header">fn <a href="#tymethod.compare" class="fn">compare</a>(self, other: Self) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a></h4></section></summary><div class="docblock"><p>Compares to another tick count.</p>
|
||
|
|
<p>Takes into account timer wrapping; if the difference is more than
|
||
|
|
half the value range, the result will be flipped.</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.wrapping_add" class="method"><a class="src rightside" href="../../src/rtic_time/timer_queue/tick_type.rs.html#27">source</a><h4 class="code-header">fn <a href="#tymethod.wrapping_add" class="fn">wrapping_add</a>(self, other: Self) -> Self</h4></section></summary><div class="docblock"><p>Wrapping addition.</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.is_at_least" class="method"><a class="src rightside" href="../../src/rtic_time/timer_queue/tick_type.rs.html#18-24">source</a><h4 class="code-header">fn <a href="#method.is_at_least" class="fn">is_at_least</a>(self, other: Self) -> <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>True if <code>self</code> is at the same time as <code>other</code> or later.</p>
|
||
|
|
<p>Takes into account timer wrapping; if the difference is more than
|
||
|
|
half the value range, the result will be negated.</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="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-TimerQueueTicks-for-u32" class="impl"><a class="src rightside" href="../../src/rtic_time/timer_queue/tick_type.rs.html#30-39">source</a><a href="#impl-TimerQueueTicks-for-u32" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.TimerQueueTicks.html" title="trait rtic_time::timer_queue::TimerQueueTicks">TimerQueueTicks</a> for <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.u32.html">u32</a></h3></section></summary><div class="impl-items"><section id="associatedconstant.ONE_TICK-1" class="associatedconstant trait-impl"><a class="src rightside" href="../../src/rtic_time/timer_queue/tick_type.rs.html#31">source</a><a href="#associatedconstant.ONE_TICK-1" class="anchor">§</a><h4 class="code-header">const <a href="#associatedconstant.ONE_TICK" class="constant">ONE_TICK</a>: Self = 1u32</h4></section><section id="method.compare" class="method trait-impl"><a class="src rightside" href="../../src/rtic_time/timer_queue/tick_type.rs.html#33-35">source</a><a href="#method.compare" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.compare" class="fn">compare</a>(self, other: Self) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a></h4></section><section id="method.wrapping_add" class="method trait-impl"><a class="src rightside" href="../../src/rtic_time/timer_queue/tick_type.rs.html#36-38">source</a><a href="#method.wrapping_add" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.wrapping_add" class="fn">wrapping_add</a>(self, other: Self) -> Self</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TimerQueueTicks-for-u64" class="impl"><a class="src rightside" href="../../src/rtic_time/timer_queue/tick_type.rs.html#40-49">source</a><a href="#impl-TimerQueueTicks-for-u64" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.TimerQueueTicks.html" title="trait rtic_time::timer_queue::TimerQueueTicks">TimerQueueTicks</a> for <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.u64.html">u64</a></h3></section></summary><div class="impl-items"><section id="associatedconstant.ONE_TICK-2" class="associatedconstant trait-impl"><a class="src rightside" href="../../src/rtic_time/timer_queue/tick_type.rs.html#41">source</a><a href="#associatedconstant.ONE_TICK-2" class="anchor">§</a><h4 class="code-header">const <a href="#associatedconstant.ONE_TICK" class="constant">ONE_TICK</a>: Self = 1u64</h4></section><section id="method.compare-1" class="method trait-impl"><a class="src rightside" href="../../src/rtic_time/timer_queue/tick_type.rs.html#43-45">source</a><a href="#method.compare-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.compare" class="fn">compare</a>(self, other: Self) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a></h4></section><section id="method.wrapping_add-1" class="method trait-impl"><a class="src rightside" href="../../src/rtic_time/timer_queue/tick_type.rs.html#46-48">source</a><a href="#method.wrapping_add-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.wrapping_add" class="fn">wrapping_add</a>(self, other: Self) -> Self</h4></section></div></details><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_q
|