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.25"
strum_macros = "0.25"
# You can also access strum_macros exports directly through strum using the "derive" feature
strum = { version = "0.25", features = ["derive"] }
Modules
- Documentation for Additional Attributes
Enums
- The
ParseErrorenum 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
'staticlifetime 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
EnumMessageand annotating your variants with#[strum(message="...")]. EnumPropertyis 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_macroscrate. 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
Enumcan be iterated over. It can be auto generated usingstrum_macroson your behalf. - A trait for retrieving the names of each variant in Enum. This trait can be autoderived by
strum_macros.