mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-10 01:58:23 +00:00
111 lines
10 KiB
HTML
111 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="Generate a flags type."><title>bitflags in bitflags - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="bitflags" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><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">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../bitflags/index.html">bitflags</a><span class="version">2.4.2</span></h2></div><div class="sidebar-elems"></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../bitflags/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Macro <a href="index.html">bitflags</a>::<wbr><a class="macro" href="#">bitflags</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/bitflags/lib.rs.html#446-585">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>bitflags {
|
||
(
|
||
$(<span class="attr">#[<span class="macro-nonterminal">$outer</span>:meta]</span>)*
|
||
<span class="macro-nonterminal">$vis</span>:vis <span class="kw">struct </span><span class="macro-nonterminal">$BitFlags</span>:ident: <span class="macro-nonterminal">$T</span>:ty {
|
||
$(
|
||
$(<span class="attr">#[<span class="macro-nonterminal">$inner</span>:ident $(<span class="macro-nonterminal">$args</span>:tt)<span class="kw-2">*</span>]</span>)*
|
||
<span class="kw">const </span><span class="macro-nonterminal">$Flag</span>:tt = <span class="macro-nonterminal">$value</span>:expr;
|
||
)*
|
||
}
|
||
|
||
$(<span class="macro-nonterminal">$t</span>:tt)*
|
||
) => { ... };
|
||
(
|
||
<span class="kw">impl </span><span class="macro-nonterminal">$BitFlags</span>:ident: <span class="macro-nonterminal">$T</span>:ty {
|
||
$(
|
||
$(<span class="attr">#[<span class="macro-nonterminal">$inner</span>:ident $(<span class="macro-nonterminal">$args</span>:tt)<span class="kw-2">*</span>]</span>)*
|
||
<span class="kw">const </span><span class="macro-nonterminal">$Flag</span>:tt = <span class="macro-nonterminal">$value</span>:expr;
|
||
)*
|
||
}
|
||
|
||
$(<span class="macro-nonterminal">$t</span>:tt)*
|
||
) => { ... };
|
||
() => { ... };
|
||
}</pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Generate a flags type.</p>
|
||
<h2 id="struct-mode"><a href="#struct-mode"><code>struct</code> mode</a></h2>
|
||
<p>A declaration that begins with <code>$vis struct</code> will generate a <code>struct</code> for a flags type, along with
|
||
methods and trait implementations for it. The body of the declaration defines flags as constants,
|
||
where each constant is a flags value of the generated flags type.</p>
|
||
<h3 id="examples"><a href="#examples">Examples</a></h3>
|
||
<p>Generate a flags type using <code>u8</code> as the bits type:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">bitflags! </span>{
|
||
<span class="kw">struct </span>Flags: u8 {
|
||
<span class="kw">const </span>A = <span class="number">1</span>;
|
||
<span class="kw">const </span>B = <span class="number">1 </span><< <span class="number">1</span>;
|
||
<span class="kw">const </span>C = <span class="number">0b0000_0100</span>;
|
||
}
|
||
}</code></pre></div>
|
||
<p>Flags types are private by default and accept standard visibility modifiers. Flags themselves
|
||
are always public:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">bitflags! </span>{
|
||
<span class="kw">pub struct </span>Flags: u8 {
|
||
<span class="comment">// Constants are always `pub`
|
||
</span><span class="kw">const </span>A = <span class="number">1</span>;
|
||
}
|
||
}</code></pre></div>
|
||
<p>Flags may refer to other flags using their <a href="trait.Flags.html#tymethod.bits" title="method bitflags::Flags::bits"><code>Flags::bits</code></a> value:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">bitflags! </span>{
|
||
<span class="kw">struct </span>Flags: u8 {
|
||
<span class="kw">const </span>A = <span class="number">1</span>;
|
||
<span class="kw">const </span>B = <span class="number">1 </span><< <span class="number">1</span>;
|
||
<span class="kw">const </span>AB = Flags::A.bits() | Flags::B.bits();
|
||
}
|
||
}</code></pre></div>
|
||
<p>A single <code>bitflags</code> invocation may include zero or more flags type declarations:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">bitflags! </span>{}
|
||
|
||
<span class="macro">bitflags! </span>{
|
||
<span class="kw">struct </span>Flags1: u8 {
|
||
<span class="kw">const </span>A = <span class="number">1</span>;
|
||
}
|
||
|
||
<span class="kw">struct </span>Flags2: u8 {
|
||
<span class="kw">const </span>A = <span class="number">1</span>;
|
||
}
|
||
}</code></pre></div>
|
||
<h2 id="impl-mode"><a href="#impl-mode"><code>impl</code> mode</a></h2>
|
||
<p>A declaration that begins with <code>impl</code> will only generate methods and trait implementations for the
|
||
<code>struct</code> defined outside of the <code>bitflags</code> macro.</p>
|
||
<p>The struct itself must be a newtype using the bits type as its field.</p>
|
||
<p>The syntax for <code>impl</code> mode is identical to <code>struct</code> mode besides the starting token.</p>
|
||
<h3 id="examples-1"><a href="#examples-1">Examples</a></h3>
|
||
<p>Implement flags methods and traits for a custom flags type using <code>u8</code> as its underlying bits type:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">struct </span>Flags(u8);
|
||
|
||
<span class="macro">bitflags! </span>{
|
||
<span class="kw">impl </span>Flags: u8 {
|
||
<span class="kw">const </span>A = <span class="number">1</span>;
|
||
<span class="kw">const </span>B = <span class="number">1 </span><< <span class="number">1</span>;
|
||
<span class="kw">const </span>C = <span class="number">0b0000_0100</span>;
|
||
}
|
||
}</code></pre></div>
|
||
<h2 id="named-and-unnamed-flags"><a href="#named-and-unnamed-flags">Named and unnamed flags</a></h2>
|
||
<p>Constants in the body of a declaration are flags. The identifier of the constant is the name of
|
||
the flag. If the identifier is <code>_</code>, then the flag is unnamed. Unnamed flags don’t appear in the
|
||
generated API, but affect how bits are truncated.</p>
|
||
<h3 id="examples-2"><a href="#examples-2">Examples</a></h3>
|
||
<p>Adding an unnamed flag that makes all bits known:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">bitflags! </span>{
|
||
<span class="kw">struct </span>Flags: u8 {
|
||
<span class="kw">const </span>A = <span class="number">1</span>;
|
||
<span class="kw">const </span>B = <span class="number">1 </span><< <span class="number">1</span>;
|
||
|
||
<span class="kw">const _ </span>= !<span class="number">0</span>;
|
||
}
|
||
}</code></pre></div>
|
||
<p>Flags types may define multiple unnamed flags:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">bitflags! </span>{
|
||
<span class="kw">struct </span>Flags: u8 {
|
||
<span class="kw">const _ </span>= <span class="number">1</span>;
|
||
<span class="kw">const _ </span>= <span class="number">1 </span><< <span class="number">1</span>;
|
||
}
|
||
}</code></pre></div>
|
||
</div></details></section></div></main></body></html> |