#macro #enum #derive #proc-macro #deriving

macro enum-kinds

Generate enums with matching variants but without any of the associated data

6 releases

0.5.1 Aug 17, 2021
0.5.0 May 13, 2020
0.4.1 Aug 22, 2018
0.4.0 Mar 10, 2018
0.3.1 Mar 7, 2018

#120 in Rust patterns

Download history 652/week @ 2021-09-28 884/week @ 2021-10-05 694/week @ 2021-10-12 675/week @ 2021-10-19 1138/week @ 2021-10-26 1715/week @ 2021-11-02 1818/week @ 2021-11-09 1230/week @ 2021-11-16 1576/week @ 2021-11-23 1521/week @ 2021-11-30 1799/week @ 2021-12-07 2163/week @ 2021-12-14 1614/week @ 2021-12-21 1284/week @ 2021-12-28 1628/week @ 2022-01-04 1657/week @ 2022-01-11

6,710 downloads per month
Used in 14 crates (8 directly)

MIT license

10KB
167 lines

enum-kinds

Build Status Latest Version Rust Documentation

Custom derive for generating enums with matching variants but without any of the data.

In other words, enum-kinds automatically generates enums that have the same set of variants as the original enum, but with all the embedded data stripped away (that is, all the variants of the newly-generated enum are unit variants). Additionally, enum-kinds implements From trait for going from the original enum to the unit variant version.

The crate is compatible with stable Rust releases. This crate replaces earlier enum_kinds_macros and enum_kinds_traits crates.

Example

#[macro_use]
extern crate enum_kinds;

#[derive(EnumKind)]
#[enum_kind(SomeEnumKind)]
enum SomeEnum {
    First(String, u32),
    Second(char),
    Third
}

#[test]
fn test_enum_kind() {
    let first = SomeEnum::First("Example".to_owned(), 32);
    assert_eq!(SomeEnumKind::from(&first), SomeEnumKind::First);
}

The #[derive(EnumKind)] attribute automatically creates another enum named SomeEnumKind that contains matching unit variant for each of the variants in SomeEnum.

Additional Attributes for Generated Enums

By default, derived kind enums implement Debug, Clone, Copy, PartialEq and Eq traits. Additional attributes can be attached to the generated enum by including them to the enum_kind attribute: #[enum_kind(NAME, derive(SomeTrait), derive(AnotherTrait))]. For example, to implement Serde's Serialize and Deserialize traits:

#[macro_use]
extern crate enum_kinds;

#[macro_use]
extern crate serde_derive;
extern crate serde;

#[derive(EnumKind)]
#[enum_kind(AdditionalDerivesKind, derive(Serialize, Deserialize))]
enum AdditionalDerives {
    Variant(String, u32),
    Another(String)
}

no_std support

enum-kinds can be used without the standard library by enabling no-stdlib feature.

Issues

If you encounter any problems using the crate, please report them at the issue tracker.

License

The crate is available under the terms of MIT license.

Dependencies

~280–700KB
~17K SLoC