mirror/rtic
1
0
Fork 0
mirror of https://github.com/rtic-rs/rtic.git synced 2024-11-26 05:29:38 +01:00
Code Issues Projects Releases Packages Wiki Activity
rtic/1/api/bitfield/macro.bitfield_debug.html

42 lines
7.7 KiB
HTML
Raw Normal View History

deploy: d251ba717393a73e9ea26a34fe738e3baec477d2
2024-10-24 07:57:30 +02:00
<!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="Generates a `fmt::Debug` implementation."><title>bitfield_debug 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_debug</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#278-323">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><span class="macro">macro_rules!</span> bitfield_debug {
(<span class="kw">struct </span><span class="macro-nonterminal">$name</span>:ident; $(<span class="macro-nonterminal">$rest</span>:tt)<span class="kw-2">*</span>) =&gt; { ... };
(<span class="macro-nonterminal">$debug_struct</span>:ident, <span class="macro-nonterminal">$self</span>:ident, <span class="attr">#[<span class="macro-nonterminal">$attribute</span>:meta] </span>$(<span class="macro-nonterminal">$rest</span>:tt)<span class="kw-2">*</span>) =&gt; { ... };
(<span class="macro-nonterminal">$debug_struct</span>:ident, <span class="macro-nonterminal">$self</span>:ident, <span class="kw">pub </span>$(<span class="macro-nonterminal">$rest</span>:tt)<span class="kw-2">*</span>) =&gt; { ... };
(<span class="macro-nonterminal">$debug_struct</span>:ident, <span class="macro-nonterminal">$self</span>:ident, <span class="kw">_</span>, <span class="macro-nonterminal">$setter</span>:tt: $(<span class="macro-nonterminal">$exprs</span>:expr),<span class="kw-2">*</span>; $(<span class="macro-nonterminal">$rest</span>:tt)<span class="kw-2">*</span>) =&gt; { ... };
(<span class="macro-nonterminal">$debug_struct</span>:ident, <span class="macro-nonterminal">$self</span>:ident, <span class="macro-nonterminal">$</span><span class="kw">type</span>:<span class="macro-nonterminal">ty</span>; $(<span class="macro-nonterminal">$rest</span>:tt)<span class="kw-2">*</span>) =&gt; { ... };
(<span class="macro-nonterminal">$debug_struct</span>:ident, <span class="macro-nonterminal">$self</span>:ident, <span class="macro-nonterminal">$getter</span>:ident, <span class="macro-nonterminal">$setter</span>:tt: <span class="macro-nonterminal">$msb</span>:expr, <span class="macro-nonterminal">$lsb</span>:expr, <span class="macro-nonterminal">$count</span>:expr;
$(<span class="macro-nonterminal">$rest</span>:tt)<span class="kw-2">*</span>) =&gt; { ... };
(<span class="macro-nonterminal">$debug_struct</span>:ident, <span class="macro-nonterminal">$self</span>:ident, <span class="macro-nonterminal">$getter</span>:ident, <span class="macro-nonterminal">$setter</span>:tt: $(<span class="macro-nonterminal">$exprs</span>:expr),<span class="kw-2">*</span>; $(<span class="macro-nonterminal">$rest</span>:tt)<span class="kw-2">*</span>) =&gt; { ... };
(<span class="macro-nonterminal">$debug_struct</span>:ident, <span class="macro-nonterminal">$self</span>:ident, from into <span class="macro-nonterminal">$into</span>:ty, $(<span class="macro-nonterminal">$rest</span>:tt)<span class="kw-2">*</span>) =&gt; { ... };
(<span class="macro-nonterminal">$debug_struct</span>:ident, <span class="macro-nonterminal">$self</span>:ident, into <span class="macro-nonterminal">$into</span>:ty, $(<span class="macro-nonterminal">$rest</span>:tt)<span class="kw-2">*</span>) =&gt; { ... };
(<span class="macro-nonterminal">$debug_struct</span>:ident, <span class="macro-nonterminal">$self</span>:ident, <span class="macro-nonterminal">$</span><span class="kw">type</span>:<span class="macro-nonterminal">ty</span>, $(<span class="macro-nonterminal">$rest</span>:tt)<span class="kw-2">*</span>) =&gt; { ... };
(<span class="macro-nonterminal">$debug_struct</span>:ident, <span class="macro-nonterminal">$self</span>:ident, ) =&gt; { ... };
}</pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Generates a <code>fmt::Debug</code> implementation.</p>
<p>This macros must be called from a <code>impl Debug for ...</code> block. It will generate the <code>fmt</code> method.</p>
<p>In most of the case, you will not directly call this macros, but use <code>bitfield</code>.</p>
<p>The syntax is <code>struct TheNameOfTheStruct</code> followed by the syntax of <code>bitfield_fields</code>.</p>
<p>The write-only fields are ignored.</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="kw">struct </span>FooBar(u32);
<span class="macro">bitfield_bitrange!</span>{<span class="kw">struct </span>FooBar(u32)}
<span class="kw">impl </span>FooBar{
<span class="macro">bitfield_fields!</span>{
u32;
field1, <span class="kw">_</span>: <span class="number">7</span>, <span class="number">0</span>;
field2, <span class="kw">_</span>: <span class="number">31</span>, <span class="number">24</span>;
}
}
<span class="kw">impl </span>std::fmt::Debug <span class="kw">for </span>FooBar {
<span class="macro">bitfield_debug!</span>{
<span class="kw">struct </span>FooBar;
field1, <span class="kw">_</span>: <span class="number">7</span>, <span class="number">0</span>;
field2, <span class="kw">_</span>: <span class="number">31</span>, <span class="number">24</span>;
}
}
<span class="kw">fn </span>main() {
<span class="kw">let </span>foobar = FooBar(<span class="number">0x11223344</span>);
<span class="macro">println!</span>(<span class="string">"{:?}"</span>, foobar);
}</code></pre></div>
</div></details></section></div></main></body></html>
Reference in a new issue Copy permalink