commit	d4a57600816e4ca44a180fe2500b118cb51c5b0f	[log] [tgz]
author	Android Build Coastguard Worker <[email protected]>	Fri Jul 07 01:18:20 2023 +0000
committer	Android Build Coastguard Worker <[email protected]>	Fri Jul 07 01:18:20 2023 +0000
tree	f8755189188b3d893bffb8e26b835c89ffed6561
parent	26d98a8407b4adb0a5247ac951a6683ad9c76fcd [diff]
parent	733af9d494ab2825a2bb069e81d2f9ba880d0abc [diff]

tree: f8755189188b3d893bffb8e26b835c89ffed6561

README.md

bitflags

License

A Rust macro to generate structures which behave like a set of bitflags

Usage

Add this to your Cargo.toml:

[dependencies]
bitflags = "2.2.1"

and this to your source code:

use bitflags::bitflags;

Example

Generate a flags structure:

use bitflags::bitflags;

// The `bitflags!` macro generates `struct`s that manage a set of flags.
bitflags! {
    #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
    struct Flags: u32 {
        const A = 0b00000001;
        const B = 0b00000010;
        const C = 0b00000100;
        const ABC = Self::A.bits() | Self::B.bits() | Self::C.bits();
    }
}

fn main() {
    let e1 = Flags::A | Flags::C;
    let e2 = Flags::B | Flags::C;
    assert_eq!((e1 | e2), Flags::ABC);   // union
    assert_eq!((e1 & e2), Flags::C);     // intersection
    assert_eq!((e1 - e2), Flags::A);     // set difference
    assert_eq!(!e2, Flags::A);           // set complement
}

Rust Version Support

The minimum supported Rust version is documented in the Cargo.toml file. This may be bumped in minor releases as necessary.