#enums #macro-derive #proc-macro #primitive #derive #enumerations #ffi

macro enum-primitive-derive

enum_primitive implementation using procedural macros to have a custom derive

6 releases

0.3.0 Nov 22, 2023
0.2.2 Oct 30, 2021
0.2.1 May 30, 2020
0.1.2 Aug 31, 2017

#386 in Rust patterns

Download history 28224/week @ 2023-11-25 26658/week @ 2023-12-02 28130/week @ 2023-12-09 22229/week @ 2023-12-16 8704/week @ 2023-12-23 21227/week @ 2023-12-30 25935/week @ 2024-01-06 28674/week @ 2024-01-13 30988/week @ 2024-01-20 33538/week @ 2024-01-27 25656/week @ 2024-02-03 36360/week @ 2024-02-10 34979/week @ 2024-02-17 42525/week @ 2024-02-24 41996/week @ 2024-03-02 14135/week @ 2024-03-09

140,326 downloads per month
Used in 204 crates (57 directly)

MIT license

15KB
130 lines

Build status Rust version Documentation Latest version All downloads Downloads of latest version

This is a custom derive, using procedural macros, implementation of enum_primitive.

MSRV is 1.56.0

Documentation

https://docs.rs/enum-primitive-derive/

Usage

Add the following to Cargo.toml:

[dependencies]
enum-primitive-derive = "^0.1"
num-traits = "^0.1"

Then to your code add:

#[macro_use]
extern crate enum_primitive_derive;
extern crate num_traits;

#[derive(Primitive)]
enum Variant {
    Value = 1,
    Another = 2,
}

To be really useful you need use num_traits::FromPrimitive or use num_traits::ToPrimitive or both. You will then be able to use num_traits::FromPrimitive and/or num_traits::ToPrimitive on your enum.

Full Example

#[macro_use]
extern crate enum_primitive_derive;
extern crate num_traits;

use num_traits::{FromPrimitive, ToPrimitive};

#[derive(Primitive)]
enum Foo {
    Bar = 32,
    Dead = 42,
    Beef = 50,
}

fn main() {
    assert_eq!(Foo::from_i32(32), Some(Foo::Bar));
    assert_eq!(Foo::from_i32(42), Some(Foo::Dead));
    assert_eq!(Foo::from_i64(50), Some(Foo::Beef));
    assert_eq!(Foo::from_isize(17), None);

    let bar = Foo::Bar;
    assert_eq!(bar.to_i32(), Some(32));

    let dead = Foo::Dead;
    assert_eq!(dead.to_isize(), Some(42));
}

Complex Example

In this case we attempt to use values created by bindgen.

#[macro_use]
extern crate enum_primitive_derive;
extern crate num_traits;

use num_traits::{FromPrimitive, ToPrimitive};

pub const ABC: ::std::os::raw::c_uint = 1;
pub const DEF: ::std::os::raw::c_uint = 2;
pub const GHI: ::std::os::raw::c_uint = 4;

#[derive(Clone, Copy, Debug, Eq, PartialEq, Primitive)]
enum BindGenLike {
    ABC = ABC as isize,
    DEF = DEF as isize,
    GHI = GHI as isize,
}

fn main() {
    assert_eq!(BindGenLike::from_isize(4), Some(BindGenLike::GHI));
    assert_eq!(BindGenLike::from_u32(2), Some(BindGenLike::DEF));
    assert_eq!(BindGenLike::from_u32(8), None);

    let abc = BindGenLike::ABC;
    assert_eq!(abc.to_u32(), Some(1));
}

Dependencies

~0.5–1MB
~22K SLoC