#enum #string #macros #proc-macros

macro sea-strum_macros

Helpful macros for working with enums and strings

3 unstable releases

0.23.0 Dec 25, 2021
0.21.2 Aug 7, 2021
0.21.1 Aug 7, 2021

#412 in Procedural macros

Download history 9533/week @ 2022-08-18 8698/week @ 2022-08-25 10994/week @ 2022-09-01 11491/week @ 2022-09-08 10911/week @ 2022-09-15 11437/week @ 2022-09-22 10547/week @ 2022-09-29 9504/week @ 2022-10-06 10908/week @ 2022-10-13 14262/week @ 2022-10-20 10784/week @ 2022-10-27 11549/week @ 2022-11-03 12287/week @ 2022-11-10 10957/week @ 2022-11-17 9737/week @ 2022-11-24 11815/week @ 2022-12-01

46,907 downloads per month
Used in 57 crates (via sea-strum)

MIT license

86KB
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.23"
strum_macros = "0.23"

# You can also use the "derive" feature, and import the macros directly from "strum"
# strum = { version = "0.23", 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
FromRepr Convert from an integer to an enum.
AsRefStr Implement AsRef<str> for MyEnum
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.

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.7–1.1MB
~24K SLoC