rtic/stable/api/rp2040_pac/generic/trait.RawReg.html

17 lines
12 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="Raw register type (`u8`, `u16`, `u32`, …)"><title>RawReg in rp2040_pac::generic - 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="rp2040_pac" 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="../../rp2040_pac/index.html">rp2040_<wbr>pac</a><span class="version">0.6.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">RawReg</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.mask" title="mask">mask</a></li><li><a href="#tymethod.one" title="one">one</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-RawReg-for-u16" title="u16">u16</a></li><li><a href="#impl-RawReg-for-u32" title="u32">u32</a></li><li><a href="#impl-RawReg-for-u64" title="u64">u64</a></li><li><a href="#impl-RawReg-for-u8" title="u8">u8</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 rp2040_<wbr>pac::<wbr>generic</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">rp2040_pac</a>::<wbr><a href="index.html">generic</a></span><h1>Trait <span class="trait">RawReg</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/rp2040_pac/generic.rs.html#3-18">source</a> </span></div><pre class="rust item-decl"><code>pub trait RawReg:
<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a>
+ <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a>
+ <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.bool.html">bool</a>&gt;
+ <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/ops/bit/trait.BitOr.html" title="trait core::ops::bit::BitOr">BitOr</a>&lt;Output = Self&gt;
+ <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/ops/bit/trait.BitAnd.html" title="trait core::ops::bit::BitAnd">BitAnd</a>&lt;Output = Self&gt;
+ <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/ops/bit/trait.BitOrAssign.html" title="trait core::ops::bit::BitOrAssign">BitOrAssign</a>
+ <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/ops/bit/trait.BitAndAssign.html" title="trait core::ops::bit::BitAndAssign">BitAndAssign</a>
+ <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/ops/bit/trait.Not.html" title="trait core::ops::bit::Not">Not</a>&lt;Output = Self&gt;
+ <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/ops/bit/trait.Shl.html" title="trait core::ops::bit::Shl">Shl</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.u8.html">u8</a>, Output = Self&gt; {
// Required methods
fn <a href="#tymethod.mask" class="fn">mask</a>&lt;const WI: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.u8.html">u8</a>&gt;() -&gt; Self;
<span class="item-spacer"></span> fn <a href="#tymethod.one" class="fn">one</a>() -&gt; Self;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Raw register type (<code>u8</code>, <code>u16</code>, <code>u32</code>, …)</p>
</div></details><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.mask" class="method"><a class="src rightside" href="../../src/rp2040_pac/generic.rs.html#15">source</a><h4 class="code-header">fn <a href="#tymethod.mask" class="fn">mask</a>&lt;const WI: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.u8.html">u8</a>&gt;() -&gt; Self</h4></section></summary><div class="docblock"><p>Mask for bits of width <code>WI</code></p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.one" class="method"><a class="src rightside" href="../../src/rp2040_pac/generic.rs.html#17">source</a><h4 class="code-header">fn <a href="#tymethod.one" class="fn">one</a>() -&gt; Self</h4></section></summary><div class="docblock"><p>Mask for bits of width 1</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="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-RawReg-for-u8" class="impl"><a class="src rightside" href="../../src/rp2040_pac/generic.rs.html#39">source</a><a href="#impl-RawReg-for-u8" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.RawReg.html" title="trait rp2040_pac::generic::RawReg">RawReg</a> for <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.u8.html">u8</a></h3></section></summary><div class="impl-items"><section id="method.mask" class="method trait-impl"><a class="src rightside" href="../../src/rp2040_pac/generic.rs.html#39">source</a><a href="#method.mask" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.mask" class="fn">mask</a>&lt;const WI: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.u8.html">u8</a>&gt;() -&gt; Self</h4></section><section id="method.one" class="method trait-impl"><a class="src rightside" href="../../src/rp2040_pac/generic.rs.html#39">source</a><a href="#method.one" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.one" class="fn">one</a>() -&gt; Self</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-RawReg-for-u16" class="impl"><a class="src rightside" href="../../src/rp2040_pac/generic.rs.html#40">source</a><a href="#impl-RawReg-for-u16" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.RawReg.html" title="trait rp2040_pac::generic::RawReg">RawReg</a> for <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.u16.html">u16</a></h3></section></summary><div class="impl-items"><section id="method.mask-1" class="method trait-impl"><a class="src rightside" href="../../src/rp2040_pac/generic.rs.html#40">source</a><a href="#method.mask-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.mask" class="fn">mask</a>&lt;const WI: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.u8.html">u8</a>&gt;() -&gt; Self</h4></section><section id="method.one-1" class="method trait-impl"><a class="src rightside" href="../../src/rp2040_pac/generic.rs.html#40">source</a><a href="#method.one-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.one" class="fn">one</a>() -&gt; Self</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-RawReg-for-u32" class="impl"><a class="src rightside" href="../../src/rp2040_pac/generic.rs.html#41">source</a><a href="#impl-RawReg-for-u32" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.RawReg.html" title="trait rp2040_pac::generic::RawReg">RawReg</a> for <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.u32.html">u32</a></h3></section></summary><div class="impl-items"><section id="method.mask-2" class="method trait-impl"><a class="src rightside" href="../../src/rp2040_pac/generic.rs.html#41">source</a><a href="#method.mask-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.mask" class="fn">mask</a>&lt;const WI: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.u8.html">u8</a>&gt;() -&gt; Self</h4></section><section id="method.one-2" class="method trait-impl"><a class="src rightside" href="../../src/rp2040_pac/generic.rs.html#41">source</a><a href="#method.one-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.one" class="fn">one</a>() -&gt; Self</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-RawReg-for-u64" class="impl"><a class="src rightside" hr