42 releases (23 stable)

new 2.5.0 Mar 19, 2024
2.4.1 Oct 15, 2023
2.3.3 Jun 27, 2023
2.0.2 Mar 19, 2023
0.1.1 Feb 9, 2015

#1 in Rust patterns

Download history 3726193/week @ 2023-11-27 3682828/week @ 2023-12-04 3812441/week @ 2023-12-11 3347487/week @ 2023-12-18 2166417/week @ 2023-12-25 3118838/week @ 2024-01-01 3786741/week @ 2024-01-08 3914438/week @ 2024-01-15 3975876/week @ 2024-01-22 4329932/week @ 2024-01-29 4157059/week @ 2024-02-05 4136447/week @ 2024-02-12 4244569/week @ 2024-02-19 4406690/week @ 2024-02-26 4330703/week @ 2024-03-04 1629324/week @ 2024-03-11

14,888,794 downloads per month
Used in 60,411 crates (2,451 directly)

MIT/Apache

140KB
3.5K SLoC

bitflags

Rust Latest version Documentation License

bitflags generates flags enums with well-defined semantics and ergonomic end-user APIs.

You can use bitflags to:

  • provide more user-friendly bindings to C APIs where flags may or may not be fully known in advance.
  • generate efficient options types with string parsing and formatting support.

You can't use bitflags to:

  • guarantee only bits corresponding to defined flags will ever be set. bitflags allows access to the underlying bits type so arbitrary bits may be set.

  • define bitfields. bitflags only generates types where set bits denote the presence of some combination of flags.

  • Documentation

  • Specification

  • Release notes

Usage

Add this to your Cargo.toml:

[dependencies]
bitflags = "2.5.0"

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! {
    /// Represents a set of flags.
    #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
    struct Flags: u32 {
        /// The value `A`, at bit position `0`.
        const A = 0b00000001;
        /// The value `B`, at bit position `1`.
        const B = 0b00000010;
        /// The value `C`, at bit position `2`.
        const C = 0b00000100;

        /// The combination of `A`, `B`, and `C`.
        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.

Dependencies

~0–435KB