Encap_Enum

Encap_Enum provides the encap_enum! macro for defining enumerations, bitflags and groups of constants.

Usage

Add this to your Cargo.toml:

[dependencies]

encap_enum = "0.2.1"

and this to your crate root:

#[macro_use]
extern crate encap_enum;

Features

• iterators.
• bit flags.
• encapsulated flag values.
  • change enum visibility for both internal values and the enum itself.
• supports any number of attributes.
  • This includes doc comments, #[repr(C)], #[derive], and many others.
• No std dependency

Example

encap_enum!{
    /// ClassStyle is a structure used in the Window class.
    #[repr(C)]
    pub enum ClassStyle: pub u32 {
        ByteAlignClient     = 0x0000_1000,
        ByteAlignWindow     = 0x0000_2000, /// Aligns window on a byte boundary.
        DoubleClicks        = 0x0000_0008,
        DropShadow          = 0x0002_0000,
        GlobalClass         = 0x0000_4000,
        // ...
    }
}
fn main() {
    println!("ByteAlignClient integer representation: {}", ClassStyle::ByteAlignClient.0);
    println!("ByteAlignClient debug representation: {:?}", ClassStyle::ByteAlignClient);
}

note: The internal data structure is a tuple struct.

License

encap_enum is licenced under the MIT Licence.

• changed encap_enum_impl to __encap_enum_impl.
  • __encap_enum_impl is hidden from documentation.
• fixed visibility bug for methods.
  • get_bit now has the same visibility as tuple struct data.