|
|
<!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="Converts enum variants to `&'a str`, where `'a` is the lifetime of the input enum reference."><title>AsRefStr in strum_macros - 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="strum_macros" 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 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">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../strum_macros/index.html">strum_macros</a><span class="version">0.26.4</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="../strum_macros/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>Derive Macro <a href="index.html">strum_macros</a>::<wbr><a class="derive" href="#">AsRefStr</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/strum_macros/lib.rs.html#176-183">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>#[derive(AsRefStr)]
|
|
|
{
|
|
|
<span class="comment">// Attributes available to this derive:</span>
|
|
|
#[strum]
|
|
|
}
|
|
|
</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Converts enum variants to <code>&'a str</code>, where <code>'a</code> is the lifetime of the input enum reference.</p>
|
|
|
<p>Implements <code>AsRef<str></code> on your enum using the same rules as
|
|
|
<code>Display</code> for determining what string is returned. The difference is that <code>as_ref()</code> returns
|
|
|
a <code>&str</code> instead of a <code>String</code> so you don’t allocate any additional memory with each call.</p>
|
|
|
<p>If you require a <code>&'static str</code>, you can use
|
|
|
<a href="derive.IntoStaticStr.html" title="derive strum_macros::IntoStaticStr"><code>strum::IntoStaticStr</code></a> instead.</p>
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="comment">// You need to bring the AsRef trait into scope to use it
|
|
|
</span><span class="kw">use </span>std::convert::AsRef;
|
|
|
<span class="kw">use </span>strum_macros::AsRefStr;
|
|
|
|
|
|
<span class="attr">#[derive(AsRefStr, Debug)]
|
|
|
</span><span class="kw">enum </span>Color {
|
|
|
<span class="attr">#[strum(serialize = <span class="string">"redred"</span>)]
|
|
|
</span>Red,
|
|
|
Green {
|
|
|
range: usize,
|
|
|
},
|
|
|
Blue(usize),
|
|
|
Yellow,
|
|
|
}
|
|
|
|
|
|
<span class="comment">// uses the serialize string for Display
|
|
|
</span><span class="kw">let </span>red = Color::Red;
|
|
|
<span class="macro">assert_eq!</span>(<span class="string">"redred"</span>, red.as_ref());
|
|
|
<span class="comment">// by default the variants Name
|
|
|
</span><span class="kw">let </span>yellow = Color::Yellow;
|
|
|
<span class="macro">assert_eq!</span>(<span class="string">"Yellow"</span>, yellow.as_ref());
|
|
|
<span class="comment">// or for string formatting
|
|
|
</span><span class="macro">println!</span>(
|
|
|
<span class="string">"blue: {} green: {}"</span>,
|
|
|
Color::Blue(<span class="number">10</span>).as_ref(),
|
|
|
Color::Green { range: <span class="number">42 </span>}.as_ref()
|
|
|
);
|
|
|
|
|
|
<span class="comment">// With prefix on all variants
|
|
|
</span><span class="attr">#[derive(AsRefStr, Debug)]
|
|
|
#[strum(prefix = <span class="string">"/"</span>)]
|
|
|
</span><span class="kw">enum </span>ColorWithPrefix {
|
|
|
<span class="attr">#[strum(serialize = <span class="string">"redred"</span>)]
|
|
|
</span>Red,
|
|
|
Green,
|
|
|
}
|
|
|
|
|
|
<span class="macro">assert_eq!</span>(<span class="string">"/redred"</span>, ColorWithPrefix::Red.as_ref());
|
|
|
<span class="macro">assert_eq!</span>(<span class="string">"/Green"</span>, ColorWithPrefix::Green.as_ref());</code></pre></div>
|
|
|
</div></details></section></div></main></body></html> |