Expand description
Strum
Strum is a set of macros and traits for working with enums and strings easier in Rust.
The full version of the README can be found on Github.
Including Strum in Your Project
Import strum and strum_macros
into your project by adding the following lines to your
Cargo.toml. strum_macros
contains the macros needed to derive all the traits in Strum.
[dependencies]
strum = "0.24"
strum_macros = "0.24"
# You can also access strum_macros exports directly through strum using the "derive" feature
strum = { version = "0.24", features = ["derive"] }
Modules
- Documentation for Additional Attributes
Enums
- The
ParseError
enum is a collection of all the possible reasons an enum can fail to parse from a string.
Traits
- AsStaticRefDeprecatedA cheap reference-to-reference conversion. Used to convert a value to a reference value with
'static
lifetime within generic code. - A trait for capturing the number of variants in Enum. This trait can be autoderived by
strum_macros
. - Associates additional pieces of information with an Enum. This can be autoimplemented by deriving
EnumMessage
and annotating your variants with#[strum(message="...")]
. EnumProperty
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 thestrum_macros
crate. Currently, the only string literals are supported in attributes, the other methods will be implemented as additional attribute types become stabilized.- This trait designates that an
Enum
can be iterated over. It can be auto generated usingstrum_macros
on your behalf. - A trait for retrieving the names of each variant in Enum. This trait can be autoderived by
strum_macros
.
Derive Macros
- Converts enum variants to
&'static str
. - Converts enum variants to strings.
- Add a constant
usize
equal to the number of variants. - Generate a new type with only the discriminant names.
- Creates a new type that iterates of the variants of an enum.
- Add a verbose message to an enum variant.
- Add custom properties to enum variants.
- Converts strings to enum variants based on their name.
- Implements
Strum::VariantNames
which adds an associated constantVARIANTS
which is an array of discriminant names. - Add a function to enum that allows accessing variants by its discriminant
- Implements
From<MyEnum> for &'static str
on an enum. - implements
std::string::ToString
on en enum