-
Notifications
You must be signed in to change notification settings - Fork 11.2k
/
derive.EnumVariantOrder.html
16 lines (15 loc) · 4.14 KB
/
derive.EnumVariantOrder.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<!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="This proc macro generates a function `order_to_variant_map` which returns a map of the position of each variant to the name of the variant. It is intended to catch changes in enum order when backward compat is required."><title>EnumVariantOrder in sui_macros - 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-c5d6553a23f1e5a6.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="sui_macros" data-themes="" data-resource-suffix="" data-rustdoc-version="1.81.0 (eeb90cda1 2024-09-04)" data-channel="1.81.0" data-search-js="search-d234aafac6c221dd.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-d2fab2bf619172d3.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-df360f571f6edeae.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 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="../sui_macros/index.html">sui_macros</a><span class="version">0.7.0</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>Derive Macro <a href="index.html">sui_macros</a>::<wbr><a class="derive" href="#">EnumVariantOrder</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/sui_proc_macros/lib.rs.html#555">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>#[derive(EnumVariantOrder)]</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This proc macro generates a function <code>order_to_variant_map</code> which returns a map
of the position of each variant to the name of the variant.
It is intended to catch changes in enum order when backward compat is required.</p>
<div class="example-wrap ignore"><a href="#" class="tooltip" title="This example is not tested">ⓘ</a><pre class="rust rust-example-rendered"><code> <span class="doccomment">/// Example for this enum
</span><span class="attr">#[derive(EnumVariantOrder)]
</span><span class="kw">pub enum </span>MyEnum {
A,
B(u64),
C{x: bool, y: i8},
}
<span class="kw">let </span>order_map = MyEnum::order_to_variant_map();
<span class="macro">assert!</span>(order_map.get(<span class="number">0</span>).unwrap() == <span class="string">"A"</span>);
<span class="macro">assert!</span>(order_map.get(<span class="number">1</span>).unwrap() == <span class="string">"B"</span>);
<span class="macro">assert!</span>(order_map.get(<span class="number">2</span>).unwrap() == <span class="string">"C"</span>);</code></pre></div>
</div></details></section></div></main></body></html>