encap_enum 0.3.1

A non-verbose way to define a group of constants and bit flags.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

# Encap_Enum

![Rust](https://github.com/Razordor/encap_enum/workflows/Rust/badge.svg)

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

## Usage

Add this to your `Cargo.toml`:
```toml
[dependencies]
encap_enum = "0.3.1"
```
and this to your crate root:
```rust
#[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.
- FFI compatible.

### Example

```rust
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.raw);
    println!("ByteAlignClient debug representation: {:?}", ClassStyle::ByteAlignClient);
}
```

### License

`encap_enum` is licenced under the [MIT Licence](https://github.com/Razordor/encap_enum/blob/master/LICENSE).

<details closed>
<summary>Recent Changes</summary>

* fixed incorrect documentation.

</details>