rtic/2/api/bitfield/trait.BitRange.html

8 lines
98 KiB
HTML
Raw Permalink 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="A trait to get or set ranges of bits."><title>BitRange in bitfield - 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="bitfield" 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="../bitfield/index.html">bitfield</a><span class="version">0.13.2</span></h2></div><h2 class="location"><a href="#">BitRange</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.bit_range">bit_range</a></li><li><a href="#tymethod.set_bit_range">set_bit_range</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-BitRange%3Ci128%3E-for-u128">u128</a></li><li><a href="#impl-BitRange%3Ci16%3E-for-u128">u128</a></li><li><a href="#impl-BitRange%3Ci32%3E-for-u128">u128</a></li><li><a href="#impl-BitRange%3Ci64%3E-for-u128">u128</a></li><li><a href="#impl-BitRange%3Ci8%3E-for-u128">u128</a></li><li><a href="#impl-BitRange%3Cu128%3E-for-u128">u128</a></li><li><a href="#impl-BitRange%3Cu16%3E-for-u128">u128</a></li><li><a href="#impl-BitRange%3Cu32%3E-for-u128">u128</a></li><li><a href="#impl-BitRange%3Cu64%3E-for-u128">u128</a></li><li><a href="#impl-BitRange%3Cu8%3E-for-u128">u128</a></li><li><a href="#impl-BitRange%3Ci128%3E-for-u16">u16</a></li><li><a href="#impl-BitRange%3Ci16%3E-for-u16">u16</a></li><li><a href="#impl-BitRange%3Ci32%3E-for-u16">u16</a></li><li><a href="#impl-BitRange%3Ci64%3E-for-u16">u16</a></li><li><a href="#impl-BitRange%3Ci8%3E-for-u16">u16</a></li><li><a href="#impl-BitRange%3Cu128%3E-for-u16">u16</a></li><li><a href="#impl-BitRange%3Cu16%3E-for-u16">u16</a></li><li><a href="#impl-BitRange%3Cu32%3E-for-u16">u16</a></li><li><a href="#impl-BitRange%3Cu64%3E-for-u16">u16</a></li><li><a href="#impl-BitRange%3Cu8%3E-for-u16">u16</a></li><li><a href="#impl-BitRange%3Ci128%3E-for-u32">u32</a></li><li><a href="#impl-BitRange%3Ci16%3E-for-u32">u32</a></li><li><a href="#impl-BitRange%3Ci32%3E-for-u32">u32</a></li><li><a href="#impl-BitRange%3Ci64%3E-for-u32">u32</a></li><li><a href="#impl-BitRange%3Ci8%3E-for-u32">u32</a></li><li><a href="#impl-BitRange%3Cu128%3E-for-u32">u32</a></li><li><a href="#impl-BitRange%3Cu16%3E-for-u32">u32</a></li><li><a href="#impl-BitRange%3Cu32%3E-for-u32">u32</a
// Required methods
fn <a href="#tymethod.bit_range" class="fn">bit_range</a>(&amp;self, msb: <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.usize.html">usize</a>, lsb: <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.usize.html">usize</a>) -&gt; T;
<span class="item-spacer"></span> fn <a href="#tymethod.set_bit_range" class="fn">set_bit_range</a>(&amp;mut self, msb: <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.usize.html">usize</a>, lsb: <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.usize.html">usize</a>, value: T);
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A trait to get or set ranges of bits.</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.bit_range" class="method"><a class="src rightside" href="../src/bitfield/lib.rs.html#579">source</a><h4 class="code-header">fn <a href="#tymethod.bit_range" class="fn">bit_range</a>(&amp;self, msb: <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.usize.html">usize</a>, lsb: <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.usize.html">usize</a>) -&gt; T</h4></section></summary><div class="docblock"><p>Get a range of bits.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.set_bit_range" class="method"><a class="src rightside" href="../src/bitfield/lib.rs.html#581">source</a><h4 class="code-header">fn <a href="#tymethod.set_bit_range" class="fn">set_bit_range</a>(&amp;mut self, msb: <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.usize.html">usize</a>, lsb: <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.usize.html">usize</a>, value: T)</h4></section></summary><div class="docblock"><p>Set a range of bits.</p>
</div></details></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-BitRange%3Ci8%3E-for-u8" class="impl"><a class="src rightside" href="../src/bitfield/lib.rs.html#648">source</a><a href="#impl-BitRange%3Ci8%3E-for-u8" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.BitRange.html" title="trait bitfield::BitRange">BitRange</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.i8.html">i8</a>&gt; for <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.u8.html">u8</a></h3></section></summary><div class="impl-items"><section id="method.bit_range" class="method trait-impl"><a class="src rightside" href="../src/bitfield/lib.rs.html#648">source</a><a href="#method.bit_range" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.bit_range" class="fn">bit_range</a>(&amp;self, msb: <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.usize.html">usize</a>, lsb: <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.usize.html">usize</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.i8.html">i8</a></h4></section><section id="method.set_bit_range" class="method trait-impl"><a class="src rightside" href="../src/bitfield/lib.rs.html#648">source</a><a href="#method.set_bit_range" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.set_bit_range" class="fn">set_bit_range</a>(&amp;mut self, msb: <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.usize.html">usize</a>, lsb: <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.usize.html">usize</a>, value: <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.i8.html">i8</a>)</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BitRange%3Ci8%3E-for-u16" class="impl"><a class="src rightside" href="../src/bitfield/lib.rs.html#648">source</a><a href="#impl-BitRange%3Ci8%3E-for-u16" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.BitRange.html" title="trait bitfield::BitRange">BitRange</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.i8.html">i8</a>&gt; 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="method.bit_range-1" class="method trait-impl"><a class="src rightside" href="../src/bitfield/lib.rs.html#648">source</a><a href="#method.bit_range-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.bit_range" class="fn">bit_range</a>(&amp;self, msb: <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.usize.html">usize</a>, lsb: <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.usize.html">usize</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.i8.html">i8</a></h4></section><section id="method.set_bit_range-1" class="method trait-impl"><a class="src rightside" href="../src/bitfield/lib.rs.html#648">source</a><a href="#method.set_bit_range-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.set_bit_range" class="fn">set_bit_range</a>(&amp;mut self, msb: <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.usize.html">usize</a>, lsb: <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.usize.html">usize</a>, value: <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.i8.html">i8</a>)</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BitRange%3Ci8%3E-for-u32" class="impl"><a class="src rightside" href="../src/bitfield/lib.rs.html#648">source</a><a href="#impl-BitRange%3Ci8%3E-for-u32" class="anchor">§</a><h3 class="code-header">impl <a class="tra