#enum #conversion #safe #ffi #derive

num_enum

Procedural macros to make inter-operation between primitives and enums easier

13 unstable releases (4 breaking)

✓ Uses Rust 2018 edition

0.5.0 May 9, 2020
0.4.3 Mar 17, 2020
0.4.2 Oct 4, 2019
0.4.1 Aug 12, 2019
0.1.1 Nov 12, 2018

#12 in Rust patterns

Download history 7785/week @ 2020-02-09 7439/week @ 2020-02-16 7135/week @ 2020-02-23 8319/week @ 2020-03-01 8322/week @ 2020-03-08 8190/week @ 2020-03-15 6907/week @ 2020-03-22 7458/week @ 2020-03-29 7658/week @ 2020-04-05 8320/week @ 2020-04-12 6711/week @ 2020-04-19 9582/week @ 2020-04-26 8417/week @ 2020-05-03 12720/week @ 2020-05-10 13787/week @ 2020-05-17 14165/week @ 2020-05-24

33,928 downloads per month
Used in 144 crates (46 directly)

BSD-3-Clause

7KB
57 lines

num_enum

Procedural macros to make inter-operation between primitives and enums easier. This crate is no_std compatible.

crates.io Documentation Build Status

Turning an enum into a primitive

use num_enum::IntoPrimitive;

#[derive(IntoPrimitive)]
#[repr(u8)]
enum Number {
    Zero,
    One,
}

fn main() {
    let zero: u8 = Number::Zero.into();
    assert_eq!(zero, 0u8);
}

num_enum's IntoPrimitive is more type-safe than using as, because as will silently truncate - num_enum only derives From for exactly the discriminant type of the enum.

Attempting to turn a primitive into an enum with try_from

use num_enum::TryFromPrimitive;
use std::convert::TryFrom;

#[derive(Debug, Eq, PartialEq, TryFromPrimitive)]
#[repr(u8)]
enum Number {
    Zero,
    One,
}

fn main() {
    let zero = Number::try_from(0u8);
    assert_eq!(zero, Ok(Number::Zero));

    let three = Number::try_from(3u8);
    assert_eq!(
        three.unwrap_err().to_string(),
        "No discriminant in enum `Number` matches the value `3`",
    );
}

Unsafely turning a primitive into an enum with from_unchecked

If you're really certain a conversion will succeed, and want to avoid a small amount of overhead, you can use unsafe code to do this conversion. Unless you have data showing that the match statement generated in the try_from above is a bottleneck for you, you should avoid doing this, as the unsafe code has potential to cause serious memory issues in your program.

use num_enum::UnsafeFromPrimitive;

#[derive(Debug, Eq, PartialEq, UnsafeFromPrimitive)]
#[repr(u8)]
enum Number {
    Zero,
    One,
}

fn main() {
    assert_eq!(
        Number::Zero,
        unsafe { Number::from_unchecked(0_u8) },
    );
    assert_eq!(
        Number::One,
        unsafe { Number::from_unchecked(1_u8) },
    );
}

unsafe fn undefined_behavior() {
    let _ = Number::from_unchecked(2); // 2 is not a valid discriminant!
}

Optional features

Some enum values may be composed of complex expressions, for example:

enum Number {
    Zero = (0, 1).0,
    One = (0, 1).1,
}

To cut down on compile time, these are not supported by default, but if you enable the complex-expressions feature of your dependency on num_enum, these should start working.

Dependencies

~0.4–0.8MB
~19K SLoC