rtic/dev/api/rtic_time/half_period_counter/trait.TimerValue.html

5 lines
9.3 KiB
HTML
Raw Normal View History

<!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 value of the timers count register."><title>TimerValue in rtic_time::half_period_counter - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.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-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.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.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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>Value</a></h2><h3><a href="#required-associated-consts">Required Associated Constants</a></h3><ul class="block"><li><a href="#associatedconstant.BITS" title="BITS">BITS</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-TimerValue-for-u16" title="u16">u16</a></li><li><a href="#impl-TimerValue-for-u32" title="u32">u32</a></li><li><a href="#impl-TimerValue-for-u64" title="u64">u64</a></li><li><a href="#impl-TimerValue-for-u8" title="u8">u8</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In rtic_<wbr>time::<wbr>half_<wbr>period_<wbr>counter</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">half_period_counter</a></span><h1>Trait <span class="trait">TimerValue</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/half_period_counter.rs.html#122-125">Source</a> </span></div><pre class="rust item-decl"><code>pub trait TimerValue {
const <a href="#associatedconstant.BITS" class="constant">BITS</a>: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/core/primitive.u32.html">u32</a>;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The value of the timers count register.</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.BITS" class="method"><a class="src rightside" href="../../src/rtic_time/half_period_counter.rs.html#124">Source</a><h4 class="code-header">const <a href="#associatedconstant.BITS" class="constant">BITS</a>: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/core/primitive.u32.html">u32</a></h4></section></summary><div class="docblock"><p>Bit size of the timer. Does not need to be a multiple of <code>8</code>.</p>
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.84.0/reference/items/traits.html#object-safety">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></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-TimerValue-for-u8" class="impl"><a class="src rightside" href="../../src/rtic_time/half_period_counter.rs.html#133">Source</a><a href="#impl-TimerValue-for-u8" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.TimerValue.html" title="trait rtic_time::half_period_counter::TimerValue">TimerValue</a> for <a class="primitive" href="https://doc.rust-lang.org/1.84.0/core/primitive.u8.html">u8</a></h3></section></summary><div class="impl-items"><section id="associatedconstant.BITS-1" class="associatedconstant trait-impl"><a class="src rightside" href="../../src/rtic_time/half_period_counter.rs.html#133">Source</a><a href="#associatedconstant.BITS-1" class="anchor">§</a><h4 class="code-header">const <a href="#associatedconstant.BITS" class="constant">BITS</a>: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/core/primitive.u32.html">u32</a> = 8u32</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TimerValue-for-u16" class="impl"><a class="src rightside" href="../../src/rtic_time/half_period_counter.rs.html#134">Source</a><a href="#impl-TimerValue-for-u16" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.TimerValue.html" title="trait rtic_time::half_period_counter::TimerValue">TimerValue</a> for <a class="primitive" href="https://doc.rust-lang.org/1.84.0/core/primitive.u16.html">u16</a></h3></section></summary><div class="impl-items"><section id="associatedconstant.BITS-2" class="associatedconstant trait-impl"><a class="src rightside" href="../../src/rtic_time/half_period_counter.rs.html#134">Source</a><a href="#associatedconstant.BITS-2" class="anchor">§</a><h4 class="code-header">const <a href="#associatedconstant.BITS" class="constant">BITS</a>: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/core/primitive.u32.html">u32</a> = 16u32</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TimerValue-for-u32" class="impl"><a class="src rightside" href="../../src/rtic_time/half_period_counter.rs.html#135">Source</a><a href="#impl-TimerValue-for-u32" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.TimerValue.html" title="trait rtic_time::half_period_counter::TimerValue">TimerValue</a> for <a class="primitive" href="https://doc.rust-lang.org/1.84.0/core/primitive.u32.html">u32</a></h3></section></summary><div class="impl-items"><section id="associatedconstant.BITS-3" class="associatedconstant trait-impl"><a class="src rightside" href="../../src/rtic_time/half_period_counter.rs.html#135">Source</a><a href="#associatedconstant.BITS-3" class="anchor">§</a><h4 class="code-header">const <a href="#associatedconstant.BITS" class="constant">BITS</a>: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/core/primitive.u32.html">u32</a> = 32u32</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TimerValue-for-u64" class="impl"><a class="src rightside" href="../../src/rtic_time/half_period_counter.rs.html#136">Source</a><a href="#impl-TimerValue-for-u64" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.TimerValue.html" title="trait rtic_time::half_period_counter::TimerValue">TimerValue</a> for <a class="primitive" href="https://doc.rust-lang.org/1.84.0/core/primitive.u64.html">u64</a></h3></section></summary><div class