mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-11-24 04:32:52 +01:00
28 lines
5.4 KiB
HTML
28 lines
5.4 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="Implements `BitRange` for a tuple struct (or “newtype”)."><title>bitfield_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 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_bitrange</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#357-444">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_bitrange {
|
||
|
|
(@impl_bitrange_slice <span class="macro-nonterminal">$name</span>:ident, <span class="macro-nonterminal">$slice_ty</span>:ty, <span class="macro-nonterminal">$bitrange_ty</span>:ty) => { ... };
|
||
|
|
(@impl_bitrange_slice_msb0 <span class="macro-nonterminal">$name</span>:ident, <span class="macro-nonterminal">$slice_ty</span>:ty, <span class="macro-nonterminal">$bitrange_ty</span>:ty) => { ... };
|
||
|
|
(<span class="kw">struct </span><span class="macro-nonterminal">$name</span>:ident([<span class="macro-nonterminal">$t</span>:ty])) => { ... };
|
||
|
|
(<span class="kw">struct </span><span class="macro-nonterminal">$name</span>:ident(MSB0 [<span class="macro-nonterminal">$t</span>:ty])) => { ... };
|
||
|
|
(<span class="kw">struct </span><span class="macro-nonterminal">$name</span>:ident(<span class="macro-nonterminal">$t</span>:ty)) => { ... };
|
||
|
|
}</pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Implements <code>BitRange</code> for a tuple struct (or “newtype”).</p>
|
||
|
|
<p>This macro will generate an implementation of the <code>BitRange</code> trait for an existing single
|
||
|
|
element tuple struct.</p>
|
||
|
|
<p>The syntax is more or less the same as declaring a “newtype”, <strong>without</strong> the attributes,
|
||
|
|
documentation comments and pub keyword.</p>
|
||
|
|
<p>The difference with a normal “newtype” is the type in parentheses. If the type is <code>[t]</code> (where
|
||
|
|
<code>t</code> is any of the unsigned integer type), the “newtype” will be generic and implement
|
||
|
|
<code>BitRange</code> for <code>T: AsMut<[t]> + AsRef<[t]></code> (for example a slice, an array or a <code>Vec</code>). You can
|
||
|
|
also use <code>MSB0 [t]</code>. The difference will be the positions of the bit. You can use the
|
||
|
|
<code>bits_positions</code> example to see where each bits is. If the type is neither of this two, the
|
||
|
|
“newtype” will wrap a value of the specified type and implements <code>BitRange</code> the same ways as
|
||
|
|
the wrapped type.</p>
|
||
|
|
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">struct </span>BitField1(u32);
|
||
|
|
<span class="macro">bitfield_bitrange!</span>{<span class="kw">struct </span>BitField1(u32)}
|
||
|
|
|
||
|
|
<span class="kw">struct </span>BitField2<T>(T);
|
||
|
|
<span class="macro">bitfield_bitrange!</span>{<span class="kw">struct </span>BitField2([u8])}
|
||
|
|
|
||
|
|
<span class="kw">struct </span>BitField3<T>(T);
|
||
|
|
<span class="macro">bitfield_bitrange!</span>{<span class="kw">struct </span>BitField3(MSB0 [u8])}</code></pre></div>
|
||
|
|
</div></details></section></div></main></body></html>
|