enum_parity 0.1.0

a macro that enforces enum discriminant bit parity
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
57
58
59
60
61
62
63
64
65
66
67
68
69

[<img alt="docs.rs" src="https://img.shields.io/docsrs/enum_parity" height="20">](https://docs.rs/enum_parity)
[<img alt="build status" src="https://img.shields.io/github/actions/workflow/status/przb/enum_parity/rust.yml" height="20">](https://github.com/przb/enum_parity/actions)

# Enum Bit Parity

This crate exposes a macro to enforce enum discriminants with a given bit parity.
Using even or odd bit parity enforces a
[Hamming weight](https://en.wikipedia.org/wiki/Hamming_weight) of two.

## Example and Usage
How to use with Cargo:
```toml
[dependencies]
enum_parity = "0.1.0"
```

To use in your crate:
```rust
use enum_parity::bit_parity;

#[bit_parity(even)]
#[repr(u8)]
pub enum EvenParitySample {
    Foo,
    Bar,
    Baz,
    Quo,
}

#[bit_parity(odd)]
#[repr(u8)]
pub enum OddParitySample {
    Lorem,
    Ipsum,
    Dolor,
    Sit,
}
```

This gets expanded to have the given bit parity as follows:
```rust
#[repr(u8)]
pub enum EvenParitySample {
    Foo = 0u8,
    Bar = 3u8,
    Baz = 5u8,
    Quo = 6u8,
}

#[repr(u8)]
pub enum OddParitySample {
    Lorem = 1u8,
    Ipsum = 2u8,
    Dolor = 4u8,
    Sit = 7u8,
}
```


## License

Dual-licensed to be compatible with the Rust project.

Licensed under the Apache License, Version 2.0
https://www.apache.org/licenses/LICENSE-2.0 or the MIT license
https://opensource.org/licenses/MIT, at your
option. This file may not be copied, modified, or distributed
except according to those terms.