enum-helper 0.2.0

Yet another enum helper. Macros that generate common boilerplate for enums.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

//! [![CI](https://github.com/uimataso/enum-helper/actions/workflows/ci.yml/badge.svg)](https://github.com/uimataso/enum-helper/actions/workflows/ci.yml)
//! [![Latest Version](https://img.shields.io/crates/v/enum-helper.svg)](https://crates.io/crates/enum-helper)
//! [![Rust Documentation](https://docs.rs/enum-helper/badge.svg)](https://docs.rs/enum-helper)
//! ![Crates.io](https://img.shields.io/crates/l/enum-helper)
//! ![Crates.io](https://img.shields.io/crates/d/enum-helper)
//!
//! Yet another enum helper.
//!
//! This crate provides derive macros that generate common boilerplate for enums.
//!
//! - [`EnumStr`]: convert between enum and string
//! - [`EnumAll`]: get an array of all variants
//! - [`EnumKind`]: generate a unit kind enum from a data-carrying enum
//!
//! ## Feature flags
//!
//! - `derive` (default): re-exports derive macros
//! - `serde`: provides serde helpers for use with [`EnumStr`]
//!
//! [`EnumStr`]: derive@enum_helper_derive::EnumStr
//! [`EnumAll`]: derive@enum_helper_derive::EnumAll
//! [`EnumKind`]: derive@enum_helper_derive::EnumKind

#[cfg(feature = "serde")]
pub mod serde;

#[cfg(feature = "derive")]
pub use enum_helper_derive::EnumAll;
#[cfg(feature = "derive")]
pub use enum_helper_derive::EnumKind;
#[cfg(feature = "derive")]
pub use enum_helper_derive::EnumStr;

/// Convert between enum and string.
///
/// Derive this trait on unit enums via [`#[derive(EnumStr)]`](derive@enum_helper_derive::EnumStr).
pub trait EnumStr: Sized {
    /// Returns the primary string name of this variant.
    fn as_name(&self) -> &'static str;

    /// Returns all string names and aliases of this variant.
    ///
    /// The first element is always the primary name (returned by [`as_name`](EnumStr::as_name)).
    /// Subsequent elements are aliases added via `alias_all` and `alias`.
    fn as_aliases(&self) -> &'static [&'static str];
}

/// Get an array of all variants of an enum.
///
/// Derive this trait on unit enums via [`#[derive(EnumAll)]`](derive@enum_helper_derive::EnumAll).
pub trait EnumAll: Sized {
    /// Array type that holds every variant.
    type All;

    /// An array containing all variants of the enum.
    const ALL: Self::All;
}

/// Get the kind of an enum variant.
///
/// Derive this trait on enums via [`#[derive(EnumKind)]`](derive@enum_helper_derive::EnumKind).
pub trait EnumKind: Sized {
    /// The unit kind enum representing the kinds of this enum.
    type Kind;

    /// Returns the kind of this variant.
    fn kind(&self) -> Self::Kind;
}