mirror of
https://github.com/esp-rs/esp-idf-hal.git
synced 2025-12-29 20:55:39 +00:00
83 lines
9.1 KiB
HTML
83 lines
9.1 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="The procedural macro used to derive `EnumSetType`, and allow enums to be used with `EnumSet`."><title>EnumSetType in enumset - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.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-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-46132b98.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="enumset" data-themes="" data-resource-suffix="" data-rustdoc-version="1.86.0-nightly (8361aef0d 2025-01-14)" data-channel="nightly" data-search-js="search-75f5ac3e.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc derive"><!--[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="../enumset/index.html">enumset</a><span class="version">1.1.5</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Enum<wbr>SetType</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#limitations" title="Limitations">Limitations</a></li><li><a href="#additional-impls" title="Additional Impls">Additional Impls</a></li><li><a href="#options" title="Options">Options</a></li><li><a href="#examples" title="Examples">Examples</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate enumset</a></h2></div></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"><span class="rustdoc-breadcrumbs"><a href="index.html">enumset</a></span><h1>Derive Macro <span class="derive">EnumSetType</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"></span></div><pre class="rust item-decl"><code>#[derive(EnumSetType)]
|
|
{
|
|
<span class="comment">// Attributes available to this derive:</span>
|
|
#[enumset]
|
|
}
|
|
</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The procedural macro used to derive <a href="trait.EnumSetType.html" title="trait enumset::EnumSetType"><code>EnumSetType</code></a>, and allow enums to be used with
|
|
<a href="struct.EnumSet.html" title="struct enumset::EnumSet"><code>EnumSet</code></a>.</p>
|
|
<h2 id="limitations"><a class="doc-anchor" href="#limitations">§</a>Limitations</h2>
|
|
<p>Currently, the following limitations apply to what kinds of enums this macro may be used with:</p>
|
|
<ul>
|
|
<li>The enum must have no data fields in any variant.</li>
|
|
<li>Variant discriminators must be zero or positive.</li>
|
|
<li>No variant discriminator may be larger than <code>0xFFFFFFBF</code>. This is chosen to limit problems
|
|
involving overflow and similar edge cases.</li>
|
|
<li>Variant discriminators must be defined with integer literals. Expressions like <code>V = 1 + 1</code>
|
|
are not currently supported.</li>
|
|
</ul>
|
|
<h2 id="additional-impls"><a class="doc-anchor" href="#additional-impls">§</a>Additional Impls</h2>
|
|
<p>In addition to the implementation of <code>EnumSetType</code>, this procedural macro creates multiple
|
|
other impls that are either required for the macro to work, or make the procedural macro more
|
|
ergonomic to use.</p>
|
|
<p>A full list of traits implemented as is follows:</p>
|
|
<ul>
|
|
<li>[<code>Copy</code>], [<code>Clone</code>], [<code>Eq</code>], [<code>PartialEq</code>] implementations are created to allow <code>EnumSet</code>
|
|
to function properly. These automatic implementations may be suppressed using
|
|
<code>#[enumset(no_super_impls)]</code>, but these traits must still be implemented in another way.</li>
|
|
<li>[<code>PartialEq</code>], <a href="core::ops::Sub"><code>Sub</code></a>, <a href="core::ops::BitAnd"><code>BitAnd</code></a>, <a href="core::ops::BitOr"><code>BitOr</code></a>, <a href="core::ops::BitXor"><code>BitXor</code></a>, and <a href="core::ops::Not"><code>Not</code></a> implementations are
|
|
created to allow the crate to be used more ergonomically in expressions. These automatic
|
|
implementations may be suppressed using <code>#[enumset(no_ops)]</code>.</li>
|
|
</ul>
|
|
<h2 id="options"><a class="doc-anchor" href="#options">§</a>Options</h2>
|
|
<p>Options are given with <code>#[enumset(foo)]</code> annotations attached to the same enum as the derive.
|
|
Multiple options may be given in the same annotation using the <code>#[enumset(foo, bar)]</code> syntax.</p>
|
|
<p>A full list of options is as follows:</p>
|
|
<ul>
|
|
<li><code>#[enumset(no_super_impls)]</code> prevents the derive from creating implementations required for
|
|
<a href="struct.EnumSet.html" title="struct enumset::EnumSet"><code>EnumSet</code></a> to function. When this attribute is specified, implementations of [<code>Copy</code>],
|
|
[<code>Clone</code>], [<code>Eq</code>], and [<code>PartialEq</code>]. This can be useful if you are using a code generator
|
|
that already derives these traits. These impls should function identically to the
|
|
automatically derived versions, or unintentional behavior may be a result.</li>
|
|
<li><code>#[enumset(no_ops)</code> prevents the derive from implementing any operator traits.</li>
|
|
<li><code>#[enumset(crate_name = "enumset2")]</code> may be used to change the name of the <code>enumset</code> crate
|
|
used in the generated code. When the <code>std</code> feature is enabled, enumset parses <code>Cargo.toml</code>
|
|
to determine the name of the crate, and this flag is unnecessary.</li>
|
|
<li><code>#[enumset(repr = "u8")]</code> may be used to specify the in-memory representation of <code>EnumSet</code>s
|
|
of this enum type. The effects of this are described in <a href="struct.EnumSet.html#ffi-safety-and-repr" title="struct enumset::EnumSet">the <code>EnumSet</code> documentation under
|
|
“FFI, Safety and <code>repr</code>”</a>. Allowed types are <code>u8</code>, <code>u16</code>, <code>u32</code>,
|
|
<code>u64</code> and <code>u128</code>. If this is not used, then the derive macro will choose a type to best fit
|
|
the enum, but there are no guarantees about which type will be chosen.</li>
|
|
<li><code>#[enumset(repr = "array")]</code> forces the <code>EnumSet</code> of this type to be backed with an array,
|
|
even if all the variants could fit into a primitive numeric type.</li>
|
|
</ul>
|
|
<p>When the <code>serde</code> feature is used, the following features may also be specified. These options
|
|
may be used (with no effect) when building without the feature enabled:</p>
|
|
<ul>
|
|
<li><code>#[enumset(serialize_repr = "…")]</code> may be used to override the way the <code>EnumSet</code> is
|
|
serialized. Valid options are <code>u8</code>, <code>u16</code>, <code>u32</code>, <code>u64</code>, <code>list</code>, <code>map</code> and <code>array</code>. For more
|
|
information, see the
|
|
<a href="struct.EnumSet.html#serialization" title="struct enumset::EnumSet">“Serialization” section of the <code>EnumSet</code> documentation</a>.</li>
|
|
<li><code>#[enumset(serialize_deny_unknown)]</code> causes the generated deserializer to return an error
|
|
for unknown bits instead of silently ignoring them.</li>
|
|
</ul>
|
|
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
|
<p>Deriving a plain EnumSetType:</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#[derive(EnumSetType)]
|
|
</span><span class="kw">pub enum </span>Enum {
|
|
A, B, C, D, E, F, G,
|
|
}</code></pre></div>
|
|
<p>Deriving a sparse EnumSetType:</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#[derive(EnumSetType)]
|
|
</span><span class="kw">pub enum </span>SparseEnum {
|
|
A = <span class="number">10</span>, B = <span class="number">20</span>, C = <span class="number">30</span>, D = <span class="number">127</span>,
|
|
}</code></pre></div>
|
|
<p>Deriving an EnumSetType without adding ops:</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="attr">#[derive(EnumSetType)]
|
|
#[enumset(no_ops)]
|
|
</span><span class="kw">pub enum </span>NoOpsEnum {
|
|
A, B, C, D, E, F, G,
|
|
}</code></pre></div>
|
|
</div></details></section></div></main></body></html> |