|
|
<!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="Strum"><title>strum - 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" 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="../crates.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 mod crate"><!--[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/index.html">strum</a><span class="version">0.26.3</span></h2></div><div class="sidebar-elems"><ul class="block">
|
|
|
<li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#derives">Derive Macros</a></li></ul></section></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/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>Crate <a class="mod" href="#">strum</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/lib.rs.html#1-260">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><h2 id="strum"><a href="#strum">Strum</a></h2>
|
|
|
<p><a href="https://travis-ci.org/Peternator7/strum"><img src="https://travis-ci.org/Peternator7/strum.svg?branch=master" alt="Build Status" /></a>
|
|
|
<a href="https://crates.io/crates/strum"><img src="https://img.shields.io/crates/v/strum.svg" alt="Latest Version" /></a>
|
|
|
<a href="https://docs.rs/strum"><img src="https://docs.rs/strum/badge.svg" alt="Rust Documentation" /></a></p>
|
|
|
<p>Strum is a set of macros and traits for working with
|
|
|
enums and strings easier in Rust.</p>
|
|
|
<p>The full version of the README can be found on <a href="https://github.com/Peternator7/strum">GitHub</a>.</p>
|
|
|
<h2 id="including-strum-in-your-project"><a href="#including-strum-in-your-project">Including Strum in Your Project</a></h2>
|
|
|
<p>Import strum and <code>strum_macros</code> into your project by adding the following lines to your
|
|
|
Cargo.toml. <code>strum_macros</code> contains the macros needed to derive all the traits in Strum.</p>
|
|
|
<div class="example-wrap"><pre class="language-toml"><code>[dependencies]
|
|
|
strum = "0.26"
|
|
|
strum_macros = "0.26"
|
|
|
|
|
|
# You can also access strum_macros exports directly through strum using the "derive" feature
|
|
|
strum = { version = "0.26", features = ["derive"] }
|
|
|
</code></pre></div></div></details><h2 id="modules" class="section-header"><a href="#modules">Modules</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="additional_attributes/index.html" title="mod strum::additional_attributes">additional_attributes</a></div><div class="desc docblock-short">Documentation for Additional Attributes</div></li></ul><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.ParseError.html" title="enum strum::ParseError">ParseError</a></div><div class="desc docblock-short">The <code>ParseError</code> enum is a collection of all the possible reasons
|
|
|
an enum can fail to parse from a string.</div></li></ul><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.AsStaticRef.html" title="trait strum::AsStaticRef">AsStaticRef</a><span class="stab deprecated" title="">Deprecated</span></div><div class="desc docblock-short">A cheap reference-to-reference conversion. Used to convert a value to a
|
|
|
reference value with <code>'static</code> lifetime within generic code.</div></li><li><div class="item-name"><a class="trait" href="trait.EnumCount.html" title="trait strum::EnumCount">EnumCount</a></div><div class="desc docblock-short">A trait for capturing the number of variants in Enum. This trait can be autoderived by
|
|
|
<code>strum_macros</code>.</div></li><li><div class="item-name"><a class="trait" href="trait.EnumMessage.html" title="trait strum::EnumMessage">EnumMessage</a></div><div class="desc docblock-short">Associates additional pieces of information with an Enum. This can be
|
|
|
autoimplemented by deriving <code>EnumMessage</code> and annotating your variants with
|
|
|
<code>#[strum(message="...")]</code>.</div></li><li><div class="item-name"><a class="trait" href="trait.EnumProperty.html" title="trait strum::EnumProperty">EnumProperty</a></div><div class="desc docblock-short"><code>EnumProperty</code> is a trait that makes it possible to store additional information
|
|
|
with enum variants. This trait is designed to be used with the macro of the same
|
|
|
name in the <code>strum_macros</code> crate. Currently, the only string literals are supported
|
|
|
in attributes, the other methods will be implemented as additional attribute types
|
|
|
become stabilized.</div></li><li><div class="item-name"><a class="trait" href="trait.IntoEnumIterator.html" title="trait strum::IntoEnumIterator">IntoEnumIterator</a></div><div class="desc docblock-short">This trait designates that an <code>Enum</code> can be iterated over. It can
|
|
|
be auto generated using the <a href="derive.EnumIter.html"><code>EnumIter</code></a> derive macro.</div></li><li><div class="item-name"><a class="trait" href="trait.VariantArray.html" title="trait strum::VariantArray">VariantArray</a></div><div class="desc docblock-short">A trait for retrieving a static array containing all the variants in an Enum.
|
|
|
This trait can be autoderived by <code>strum_macros</code>. For derived usage, all the
|
|
|
variants in the enumerator need to be unit-types, which means you can’t autoderive
|
|
|
enums with inner data in one or more variants. Consider using it alongside
|
|
|
<a href="derive.EnumDiscriminants.html" title="derive strum::EnumDiscriminants"><code>EnumDiscriminants</code></a> if you require inner data but still want to have an
|
|
|
static array of variants.</div></li><li><div class="item-name"><a class="trait" href="trait.VariantIterator.html" title="trait strum::VariantIterator">VariantIterator</a></div></li><li><div class="item-name"><a class="trait" href="trait.VariantMetadata.html" title="trait strum::VariantMetadata">VariantMetadata</a></div></li><li><div class="item-name"><a class="trait" href="trait.VariantNames.html" title="trait strum::VariantNames">VariantNames</a></div><div class="desc docblock-short">A trait for retrieving the names of each variant in Enum. This trait can
|
|
|
be autoderived by <code>strum_macros</code>.</div></li></ul><h2 id="derives" class="section-header"><a href="#derives">Derive Macros</a></h2><ul class="item-table"><li><div class="item-name"><a class="derive" href="derive.AsRefStr.html" title="derive strum::AsRefStr">AsRefStr</a></div><div class="desc docblock-short">Converts enum variants to <code>&'a str</code>, where <code>'a</code> is the lifetime of the input enum reference.</div></li><li><div class="item-name"><a class="derive" href="derive.Display.html" title="derive strum::Display">Display</a></div><div class="desc docblock-short">Converts enum variants to strings.</div></li><li><div class="item-name"><a class="derive" href="derive.EnumCount.html" title="derive strum::EnumCount">EnumCount</a></div><div class="desc docblock-short">Add a constant <code>usize</code> equal to the number of variants.</div></li><li><div class="item-name"><a class="derive" href="derive.EnumDiscriminants.html" title="derive strum::EnumDiscriminants">EnumDiscriminants</a></div><div class="desc docblock-short">Generate a new type with only the discriminant names.</div></li><li><div class="item-name"><a class="derive" href="derive.EnumIs.html" title="derive strum::EnumIs">EnumIs</a></div><div class="desc docblock-short">Generated <code>is_*()</code> methods for each variant.
|
|
|
E.g. <code>Color.is_red()</code>.</div></li><li><div class="item-name"><a class="derive" href="derive.EnumIter.html" title="derive strum::EnumIter">EnumIter</a></div><div class="desc docblock-short">Creates a new type that iterates of the variants of an enum.</div></li><li><div class="item-name"><a class="derive" href="derive.EnumMessage.html" title="derive strum::EnumMessage">EnumMessage</a></div><div class="desc docblock-short">Add a verbose message to an enum variant.</div></li><li><div class="item-name"><a class="derive" href="derive.EnumProperty.html" title="derive strum::EnumProperty">EnumProperty</a></div><div class="desc docblock-short">Add custom properties to enum variants.</div></li><li><div class="item-name"><a class="derive" href="derive.EnumString.html" title="derive strum::EnumString">EnumString</a></div><div class="desc docblock-short">Converts strings to enum variants based on their name.</div></li><li><div class="item-name"><a class="derive" href="derive.EnumTryAs.html" title="derive strum::EnumTryAs">EnumTryAs</a></div><div class="desc docblock-short">Generated <code>try_as_*()</code> methods for all tuple-style variants.
|
|
|
E.g. <code>Message.try_as_write()</code>.</div></li><li><div class="item-name"><a class="derive" href="derive.FromRepr.html" title="derive strum::FromRepr">FromRepr</a></div><div class="desc docblock-short">Add a function to enum that allows accessing variants by its discriminant</div></li><li><div class="item-name"><a class="derive" href="derive.IntoStaticStr.html" title="derive strum::IntoStaticStr">IntoStaticStr</a></div><div class="desc docblock-short">Implements <code>From<MyEnum> for &'static str</code> on an enum.</div></li><li><div class="item-name"><a class="derive" href="derive.VariantArray.html" title="derive strum::VariantArray">VariantArray</a></div><div class="desc docblock-short">Adds a <code>'static</code> slice with all of the Enum’s variants.</div></li><li><div class="item-name"><a class="derive" href="derive.VariantNames.html" title="derive strum::VariantNames">VariantNames</a></div><div class="desc docblock-short">Implements <code>Strum::VariantNames</code> which adds an associated constant <code>VARIANTS</code> which is a <code>'static</code> slice of discriminant names.</div></li></ul></section></div></main></body></html> |