#enum #integer

macro no-std enumn

Convert number to enum

6 releases

0.1.5 Aug 3, 2022
0.1.4 Apr 30, 2022
0.1.3 Jun 16, 2020
0.1.2 Feb 4, 2020
0.1.0 Dec 6, 2018

#485 in Rust patterns

Download history 21881/week @ 2022-06-07 20505/week @ 2022-06-14 22173/week @ 2022-06-21 19515/week @ 2022-06-28 19615/week @ 2022-07-05 17699/week @ 2022-07-12 18495/week @ 2022-07-19 19486/week @ 2022-07-26 20722/week @ 2022-08-02 19940/week @ 2022-08-09 21613/week @ 2022-08-16 20500/week @ 2022-08-23 23193/week @ 2022-08-30 20428/week @ 2022-09-06 22516/week @ 2022-09-13 18098/week @ 2022-09-20

88,656 downloads per month
Used in 23 crates (10 directly)

MIT/Apache

10KB
88 lines

Convert number to enum

github crates.io docs.rs build status

This crate provides a derive macro to generate a function for converting a primitive integer into the corresponding variant of an enum.

The generated function is named n and has the following signature:

impl YourEnum {
    pub fn n(value: Repr) -> Option<Self>;
}

where Repr is an integer type of the right size as described in more detail below.

Example

use enumn::N;

#[derive(PartialEq, Debug, N)]
enum Status {
    LegendaryTriumph,
    QualifiedSuccess,
    FortuitousRevival,
    IndeterminateStalemate,
    RecoverableSetback,
    DireMisadventure,
    AbjectFailure,
}

fn main() {
    let s = Status::n(1);
    assert_eq!(s, Some(Status::QualifiedSuccess));

    let s = Status::n(9);
    assert_eq!(s, None);
}

Signature

The generated signature depends on whether the enum has a #[repr(..)] attribute. If a repr is specified, the input to n will be required to be of that type.

#[derive(enumn::N)]
#[repr(u8)]
enum E {
    /* ... */
}

// expands to:
impl E {
    pub fn n(value: u8) -> Option<Self> {
        /* ... */
    }
}

On the other hand if no repr is specified then we get a signature that is generic over a variety of possible types.

impl E {
    pub fn n<REPR: Into<i64>>(value: REPR) -> Option<Self> {
        /* ... */
    }
}

Discriminants

The conversion respects explictly specified enum discriminants. Consider this enum:

#[derive(enumn::N)]
enum Letter {
    A = 65,
    B = 66,
}

Here Letter::n(65) would return Some(Letter::A).


License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~220–630KB
~15K SLoC