Bitmask-Enum

A bitmask enum attribute macro, to turn an enum into a bitmask.

A bitmask can have unsigned integer types, the default type is usize.

Don't know how to document in proc-macro crates so if you want to see a better documentation, run cargo doc --open and select your #[bitmask] enum.

```rust

[bitmask] // usize

enum Bitmask { /* ... */ }

[bitmask(u8)] // u8

enum BitmaskU8 { /* ... */ } ```

Example

```rust use bitmask_enum::bitmask;

[bitmask(u8)]

enum Bitmask { Flag1, // defaults to 0d00000001 Flag2, // defaults to 0d00000010 Flag3, // defaults to 0d00000100 }

// bitmask has const bitwise operator methods const CONST_BM: Bitmask = Bitmask::Flag2.or(Bitmask::Flag3);

println!("{:#010b}", CONST_BM); // 0b00000110

// Bitmask that contains Flag1 and Flag3 let bm = Bitmask::Flag1 | Bitmask::Flag3;

println!("{:#010b}", bm); // 0b00000101

// Does bm intersect one of CONSTBM println!("{}", bm.intersects(CONSTBM)); // true

// Does bm contain all of CONSTBM println!("{}", bm.contains(CONSTBM)); // false ```

Custom Values

You can assign every flag a custom value.

Because behind the scences enum Bitmask gets converted to a struct Bitmask(u8); you need to wrap u8 expressions into a Self(_).

```rust use bitmask_enum::bitmask;

[bitmask(u8)]

enum Bitmask { Flag1 = Self(0b00010000), Flag2 = Self(0b00000100), Flag3 = Self(0b00000001),

Flag13_1 = Self(0b00010000 | 0b00000001),
Flag13_2 = Self::Flag1.or(Self::Flag3),

Flag4 = Self({
    let left = Self::Flag13_1;
    left.0 | Self::Flag2.0
}),

}

let bm = Bitmask::Flag1 | Bitmask::Flag3;

println!("{:#010b}", bm); // 0b00010001 println!("{}", bm == Bitmask::Flag131); // true println!("{}", bm == Bitmask::Flag132); // true

println!("{:#010b}", Bitmask::Flag4); // 0b00010101 ```