Skip to main content

EnumVariants

Derive Macro EnumVariants 

Source
#[derive(EnumVariants)]
{
    // Attributes available to this derive:
    #[enuminfo]
}
Expand description

Derives a static slice and enumeration helpers containing all variants of a unit enum.

This macro implements the following items on the enum:

  • pub const VARIANTS: &'static [Self]: An associated static slice containing all (non-ignored) unit variant instances.
  • pub const fn variants() -> &'static [Self]: Returns Self::VARIANTS.
  • pub const fn variant_count() -> usize: Returns the total number of variants in the static slice (Self::VARIANTS.len()).

§Attributes

  • #[enuminfo(ignore_variant)]: Variant attribute that excludes the variant from the generated VARIANTS slice, variants(), and variant_count().
  • #[enuminfo(rename = "...")] / #[enuminfo(rename_all = "...")]: Accepted on enum and variant levels for attribute compatibility when derived together with EnumName or EnumFromName, but has no effect on the instances placed in VARIANTS.

§Limitations

This macro supports Unit Enums only. Variants must have no data fields:

  • Unit variants (e.g. Variant)
  • Empty tuple variants (e.g. Variant())
  • Empty struct variants (e.g. Variant {})

Variants with fields will cause a compilation error.

§Feature Flags

If the impl-enuminfo feature is enabled, this macro additionally implements the enuminfo::EnumVariants trait for the enum.

§Example

use enuminfo_macros::EnumVariants;

#[derive(Debug, PartialEq, EnumVariants)]
enum Direction {
    North,
    South,
    East,
    West,
    #[enuminfo(ignore_variant)]
    Unknown,
}

// Retrieve slice of all variants
assert_eq!(
    Direction::variants(),
    &[Direction::North, Direction::South, Direction::East, Direction::West]
);

// Direct access to the associated constant
assert_eq!(Direction::VARIANTS.len(), 4);

// Get the total variant count
assert_eq!(Direction::variant_count(), 4);