mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-11-29 23:14:34 +01:00
19 lines
18 KiB
HTML
19 lines
18 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="Operations a type has to support in order to be used as the return value of `calculate_now`."><title>TimerOps in rtic_time::half_period_counter - 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>Ops</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.MAX">MAX</a></li><li><a href="#associatedconstant.ONE">ONE</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.add">add</a></li><li><a href="#tymethod.and">and</a></li><li><a href="#tymethod.left_shift">left_shift</a></li><li><a href="#tymethod.xor">xor</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-TimerOps-for-u128">u128</a></li><li><a href="#impl-TimerOps-for-u16">u16</a></li><li><a href="#impl-TimerOps-for-u32">u32</a></li><li><a href="#impl-TimerOps-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>half_<wbr>period_<wbr>counter</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">half_period_counter</a>::<wbr><a class="trait" href="#">TimerOps</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/half_period_counter.rs.html#141-154">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait TimerOps: <a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> {
|
||
|
|
const <a href="#associatedconstant.MAX" class="constant">MAX</a>: Self;
|
||
|
|
const <a href="#associatedconstant.ONE" class="constant">ONE</a>: Self;
|
||
|
|
|
||
|
|
// Required methods
|
||
|
|
fn <a href="#tymethod.xor" class="fn">xor</a>(self, other: Self) -> Self;
|
||
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.and" class="fn">and</a>(self, other: Self) -> Self;
|
||
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.add" class="fn">add</a>(self, other: Self) -> Self;
|
||
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.left_shift" class="fn">left_shift</a>(self, amount: <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.u32.html">u32</a>) -> Self;
|
||
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Operations a type has to support
|
||
|
|
in order to be used as the return value
|
||
|
|
of <a href="fn.calculate_now.html" title="fn rtic_time::half_period_counter::calculate_now"><code>calculate_now</code></a>.</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.MAX" class="method"><a class="src rightside" href="../../src/rtic_time/half_period_counter.rs.html#143">source</a><h4 class="code-header">const <a href="#associatedconstant.MAX" class="constant">MAX</a>: Self</h4></section></summary><div class="docblock"><p>All bits set to <code>1</code>.</p>
|
||
|
|
</div></details><details class="toggle" open><summary><section id="associatedconstant.ONE" class="method"><a class="src rightside" href="../../src/rtic_time/half_period_counter.rs.html#145">source</a><h4 class="code-header">const <a href="#associatedconstant.ONE" class="constant">ONE</a>: Self</h4></section></summary><div class="docblock"><p>The lowest bit set to <code>1</code>.</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.xor" class="method"><a class="src rightside" href="../../src/rtic_time/half_period_counter.rs.html#147">source</a><h4 class="code-header">fn <a href="#tymethod.xor" class="fn">xor</a>(self, other: Self) -> Self</h4></section></summary><div class="docblock"><p>The <code>^</code> operation.</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.and" class="method"><a class="src rightside" href="../../src/rtic_time/half_period_counter.rs.html#149">source</a><h4 class="code-header">fn <a href="#tymethod.and" class="fn">and</a>(self, other: Self) -> Self</h4></section></summary><div class="docblock"><p>The <code>&</code> operation.</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.add" class="method"><a class="src rightside" href="../../src/rtic_time/half_period_counter.rs.html#151">source</a><h4 class="code-header">fn <a href="#tymethod.add" class="fn">add</a>(self, other: Self) -> Self</h4></section></summary><div class="docblock"><p>The <code>+</code> operation.</p>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.left_shift" class="method"><a class="src rightside" href="../../src/rtic_time/half_period_counter.rs.html#153">source</a><h4 class="code-header">fn <a href="#tymethod.left_shift" class="fn">left_shift</a>(self, amount: <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.u32.html">u32</a>) -> Self</h4></section></summary><div class="docblock"><p>The <code><<</code> operation.</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-TimerOps-for-u16" class="impl"><a class="src rightside" href="../../src/rtic_time/half_period_counter.rs.html#185">source</a><a href="#impl-TimerOps-for-u16" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.TimerOps.html" title="trait rtic_time::half_period_counter::TimerOps">TimerOps</a> for <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.u16.html">u16</a></h3></section></summary><div class="impl-items"><section id="associatedconstant.MAX-1" class="associatedconstant trait-impl"><a class="src rightside" href="../../src/rtic_time/half_period_counter.rs.html#185">source</a><a href="#associatedconstant.MAX-1" class="anchor">§</a><h4 class="code-header">const <a href="#associatedconstant.MAX" class="constant">MAX</a>: Self = 65_535u16</h4></section><section id="associatedconstant.ONE-1" class="associatedconstant trait-impl"><a class="src rightside" href="../../src/rtic_time/half_period_counter.rs.html#185">source</a><a href="#associatedconstant.ONE-1" class="anchor">§</a><h4 class="code-header">const <a href="#associatedconstant.ONE" class="constant">ONE</a>: Self = 1u16</h4></section><section id="method.xor" class="method trait-impl"><a class="src rightside" href="../../src/rtic_time/half_period_counter.rs.html#185">source</a><a href="#method.xor" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.xor" class="fn">xor</a>(self, other: Self) -> Self</h4></section><section id="method.and" class="method trait-impl"><a class="src rightside" href="../../src/rtic_time/half_period_counter.rs.html#185">source</a><a href="#method.and" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.and" class="fn">and</a>(self, other: Self) -> Self</h4></section><section id="method.add" class="method trait-impl"><a class="src rightside" href="../../src/rtic_time/half_period_counter.rs.html#185">source</a><a href="#method.add" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.add" class="fn">add</a>(self, other: Self) -> Self</h4></section><section id="method.left_shift" class="method trait-impl"><a class="src rightside" href="../../src/rtic_time/half_period_counter.rs.html#185">source</a><a href="#method.left_shift" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.left_shift" class="fn">left_shift</a>(self, amount: <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.u32.html">u32</a>) -> Self</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TimerOps-for-u32" class="impl"><a class="src rightside" href="../../src/rtic_time/half_period_counter.rs.html#186">source</a><a href="#impl-TimerOps-for-u32" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.TimerOps.html" title="trait rtic_time::half_period_counter::TimerOps">TimerOps</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.MAX-2" class="associatedconstant trait-impl"><a class="src rightside" href="../../src/rtic_time/half_period_counter.rs.html#186">source</a><a href="#associatedconstant.MAX-2" class="anchor">§</a><h4 class="code-header">const <a href="#associatedconstant.MAX" class="constant">MAX</a>: Self = 4_294_967_295u32</h4></section><section id="associatedconstant.ONE-2" class="associatedconstant trait-impl"><a class="src rightside" href="../../src/rtic_time/half_period_counter.rs.html#186">source</a><a href="#associatedconstant.ONE-2" c
|