strum 0.18.0

Helpful macros for working with enums and strings
Documentation

Strum

Build Status Latest Version Rust Documentation

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.18.0"
strum_macros = "0.18.0"

And add these lines to the root of your project, either lib.rs or main.rs.

// Strum contains all the trait definitions
extern crate strum;
#[macro_use]
extern crate strum_macros;
# fn main() {}

Strum Macros

Strum has implemented the following macros:

Macro Description
EnumString Converts strings to enum variants based on their name
Display Converts enum variants to strings
AsRefStr Converts enum variants to &'static str
IntoStaticStr Implements From<MyEnum> for &'static str on an enum
EnumVariantNames Implements Strum::VariantNames which adds an associated constant VARIANTS which is an array of discriminant names
EnumIter Creates a new type that iterates of the variants of an enum.
EnumProperty Add custom properties to enum variants.
EnumMessage Add a verbose message to an enum variant.
EnumDiscriminants Generate a new type with only the discriminant names.
EnumCount Add a constant usize equal to the number of variants.