28 releases (17 breaking)

0.21.1 Jun 2, 2021
0.20.1 Nov 21, 2020
0.18.0 Mar 2, 2020
0.17.1 Dec 20, 2019
0.5.0 Feb 23, 2017

#5 in Procedural macros

Download history 92229/week @ 2021-02-24 91122/week @ 2021-03-03 97592/week @ 2021-03-10 98617/week @ 2021-03-17 99265/week @ 2021-03-24 98490/week @ 2021-03-31 115652/week @ 2021-04-07 107246/week @ 2021-04-14 116281/week @ 2021-04-21 116346/week @ 2021-04-28 110181/week @ 2021-05-05 112351/week @ 2021-05-12 109856/week @ 2021-05-19 111859/week @ 2021-05-26 114990/week @ 2021-06-02 102848/week @ 2021-06-09

455,133 downloads per month
Used in 947 crates (279 directly)

MIT license

75KB
1.5K SLoC

Strum

Build Status Build status Latest Version Rust Documentation Crates.io Crates.io

Strum is a set of macros and traits for working with enums and strings easier in Rust.

Compatibility

Strum is currently with versions of rustc >= 1.32.0. Pull Requests that improve compatibility with older versions are welcome. The project goal is to support a rust version for at least 2 years after release and even longer is preferred since this project changes slowly.

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.21"
strum_macros = "0.21"

# You can also use the "derive" feature, and import the macros directly from "strum"
# strum = { version = "0.21", features = ["derive"] }

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 Adds an associated VARIANTS constant 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.
ToString Serialize an enum to a String.

Contributing

Thanks for your interest in contributing. The project is divided into 3 parts, the traits are in the /strum folder. The procedural macros are in the /strum_macros folder, and the integration tests are in /strum_tests. If you are adding additional features to strum or strum_macros, you should make sure to run the tests and add new integration tests to make sure the features work as expected.

Debugging

To see the generated code, set the STRUM_DEBUG environment variable before compiling your code. STRUM_DEBUG=1 will dump all of the generated code for every type. STRUM_DEBUG=YourType will only dump the code generated on a type named YourType.

Name

Strum is short for STRing enUM because it's a library for augmenting enums with additional information through strings.

Strumming is also a very whimsical motion, much like writing Rust code.

Dependencies

~0.8–1.2MB
~25K SLoC