mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-12-26 11:59:33 +01:00
53 lines
10 KiB
HTML
53 lines
10 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="Combines `bitfield_bitrange` and `bitfield_fields`."><title>bitfield 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 macro"><!--[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><div class="sidebar-elems"></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>Macro <a href="index.html">bitfield</a>::<wbr><a class="macro" href="#">bitfield</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/bitfield/lib.rs.html#503-567">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><span class="macro">macro_rules!</span> bitfield {
|
||
|
|
($(<span class="attr">#[<span class="macro-nonterminal">$attribute</span>:meta]</span>)* <span class="kw">pub struct </span>$(<span class="macro-nonterminal">$rest</span>:tt)<span class="kw-2">*</span>) => { ... };
|
||
|
|
($(<span class="attr">#[<span class="macro-nonterminal">$attribute</span>:meta]</span>)* <span class="kw">struct </span>$(<span class="macro-nonterminal">$rest</span>:tt)<span class="kw-2">*</span>) => { ... };
|
||
|
|
($(<span class="attr">#[<span class="macro-nonterminal">$attribute</span>:meta]</span>)* ($(<span class="macro-nonterminal">$vis</span>:tt)<span class="kw-2">*</span>) <span class="kw">struct </span><span class="macro-nonterminal">$name</span>:ident($(<span class="macro-nonterminal">$</span><span class="kw">type</span>:<span class="macro-nonterminal">tt</span>)<span class="kw-2">*</span>); <span class="kw">impl </span>Debug; no default BitRange; $(<span class="macro-nonterminal">$rest</span>:tt)<span class="kw-2">*</span>) => { ... };
|
||
|
|
($(<span class="attr">#[<span class="macro-nonterminal">$attribute</span>:meta]</span>)* ($(<span class="macro-nonterminal">$vis</span>:tt)<span class="kw-2">*</span>) <span class="kw">struct </span><span class="macro-nonterminal">$name</span>:ident([<span class="macro-nonterminal">$t</span>:ty]); no default BitRange; <span class="kw">impl </span>Debug; $(<span class="macro-nonterminal">$rest</span>:tt)<span class="kw-2">*</span>) => { ... };
|
||
|
|
($(<span class="attr">#[<span class="macro-nonterminal">$attribute</span>:meta]</span>)* ($(<span class="macro-nonterminal">$vis</span>:tt)<span class="kw-2">*</span>) <span class="kw">struct </span><span class="macro-nonterminal">$name</span>:ident([<span class="macro-nonterminal">$t</span>:ty]); no default BitRange; $(<span class="macro-nonterminal">$rest</span>:tt)<span class="kw-2">*</span>) => { ... };
|
||
|
|
($(<span class="attr">#[<span class="macro-nonterminal">$attribute</span>:meta]</span>)* ($(<span class="macro-nonterminal">$vis</span>:tt)<span class="kw-2">*</span>) <span class="kw">struct </span><span class="macro-nonterminal">$name</span>:ident([<span class="macro-nonterminal">$t</span>:ty]); $(<span class="macro-nonterminal">$rest</span>:tt)<span class="kw-2">*</span>) => { ... };
|
||
|
|
($(<span class="attr">#[<span class="macro-nonterminal">$attribute</span>:meta]</span>)* ($(<span class="macro-nonterminal">$vis</span>:tt)<span class="kw-2">*</span>) <span class="kw">struct </span><span class="macro-nonterminal">$name</span>:ident(MSB0 [<span class="macro-nonterminal">$t</span>:ty]); no default BitRange; $(<span class="macro-nonterminal">$rest</span>:tt)<span class="kw-2">*</span>) => { ... };
|
||
|
|
($(<span class="attr">#[<span class="macro-nonterminal">$attribute</span>:meta]</span>)* ($(<span class="macro-nonterminal">$vis</span>:tt)<span class="kw-2">*</span>) <span class="kw">struct </span><span class="macro-nonterminal">$name</span>:ident(MSB0 [<span class="macro-nonterminal">$t</span>:ty]); $(<span class="macro-nonterminal">$rest</span>:tt)<span class="kw-2">*</span>) => { ... };
|
||
|
|
($(<span class="attr">#[<span class="macro-nonterminal">$attribute</span>:meta]</span>)* ($(<span class="macro-nonterminal">$vis</span>:tt)<span class="kw-2">*</span>) <span class="kw">struct </span><span class="macro-nonterminal">$name</span>:ident(<span class="macro-nonterminal">$t</span>:ty); no default BitRange; <span class="kw">impl </span>Debug; $(<span class="macro-nonterminal">$rest</span>:tt)<span class="kw-2">*</span>) => { ... };
|
||
|
|
($(<span class="attr">#[<span class="macro-nonterminal">$attribute</span>:meta]</span>)* ($(<span class="macro-nonterminal">$vis</span>:tt)<span class="kw-2">*</span>) <span class="kw">struct </span><span class="macro-nonterminal">$name</span>:ident(<span class="macro-nonterminal">$t</span>:ty); no default BitRange; $(<span class="macro-nonterminal">$rest</span>:tt)<span class="kw-2">*</span>) => { ... };
|
||
|
|
($(<span class="attr">#[<span class="macro-nonterminal">$attribute</span>:meta]</span>)* ($(<span class="macro-nonterminal">$vis</span>:tt)<span class="kw-2">*</span>) <span class="kw">struct </span><span class="macro-nonterminal">$name</span>:ident(<span class="macro-nonterminal">$t</span>:ty); $(<span class="macro-nonterminal">$rest</span>:tt)<span class="kw-2">*</span>) => { ... };
|
||
|
|
}</pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Combines <code>bitfield_bitrange</code> and <code>bitfield_fields</code>.</p>
|
||
|
|
<p>The syntax of this macro is the syntax of a tuple struct, including attributes and
|
||
|
|
documentation comments, followed by a semicolon, some optional elements, and finally the fields
|
||
|
|
as described in the <code>bitfield_fields</code> documentation.</p>
|
||
|
|
<p>The first optional element is <code>no default BitRange;</code>. With that, no implementation of
|
||
|
|
<code>BitRange</code> will be generated.</p>
|
||
|
|
<p>The second optional element is <code>impl Debug;</code>. This will generate an implementation of
|
||
|
|
<code>fmt::Debug</code> with the <code>bitfield_debug</code> macro.</p>
|
||
|
|
<p>The difference with calling those macros separately is that <code>bitfield_fields</code> is called
|
||
|
|
from an appropriate <code>impl</code> block. If you use the non-slice form of <code>bitfield_bitrange</code>, the
|
||
|
|
default type for <code>bitfield_fields</code> will be set to the wrapped fields.</p>
|
||
|
|
<p>See the documentation of these macros for more information on their respective syntax.</p>
|
||
|
|
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">bitfield!</span>{
|
||
|
|
<span class="kw">pub struct </span>BitField1(u16);
|
||
|
|
<span class="kw">impl </span>Debug;
|
||
|
|
<span class="comment">// The fields default to u16
|
||
|
|
</span>field1, set_field1: <span class="number">10</span>, <span class="number">0</span>;
|
||
|
|
<span class="kw">pub </span>field2, <span class="kw">_ </span>: <span class="number">12</span>, <span class="number">3</span>;
|
||
|
|
}</code></pre></div>
|
||
|
|
<p>or with a custom <code>BitRange</code> implementation :</p>
|
||
|
|
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">bitfield!</span>{
|
||
|
|
<span class="kw">pub struct </span>BitField1(u16);
|
||
|
|
no default BitRange;
|
||
|
|
<span class="kw">impl </span>Debug;
|
||
|
|
u8;
|
||
|
|
field1, set_field1: <span class="number">10</span>, <span class="number">0</span>;
|
||
|
|
<span class="kw">pub </span>field2, <span class="kw">_ </span>: <span class="number">12</span>, <span class="number">3</span>;
|
||
|
|
}
|
||
|
|
<span class="kw">impl </span>BitRange<u8> <span class="kw">for </span>BitField1 {
|
||
|
|
<span class="kw">fn </span>bit_range(<span class="kw-2">&</span><span class="self">self</span>, msb: usize, lsb: usize) -> u8 {
|
||
|
|
<span class="kw">let </span>width = msb - lsb + <span class="number">1</span>;
|
||
|
|
<span class="kw">let </span>mask = (<span class="number">1 </span><< width) - <span class="number">1</span>;
|
||
|
|
((<span class="self">self</span>.<span class="number">0 </span>>> lsb) & mask) <span class="kw">as </span>u8
|
||
|
|
}
|
||
|
|
<span class="kw">fn </span>set_bit_range(<span class="kw-2">&mut </span><span class="self">self</span>, msb: usize, lsb: usize, value: u8) {
|
||
|
|
<span class="self">self</span>.<span class="number">0 </span>= (value <span class="kw">as </span>u16) << lsb;
|
||
|
|
}
|
||
|
|
}</code></pre></div>
|
||
|
|
</div></details></section></div></main></body></html>
|