bitx 0.2.0

More ergonomic way to deal with bitfield-like struct.
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

# `bitx` [![Version]][crates.io] [![License]][crates.io] [![Docs]][docs.rs]

[Version]: https://img.shields.io/crates/v/bitx.svg
[License]: https://img.shields.io/crates/l/bitx.svg
[crates.io]: https://crates.io/crates/bitx
[Docs]: https://docs.rs/bitx/badge.svg
[docs.rs]: https://docs.rs/bitx/latest/bitx

`bitx` provides a prodecural macro for defining structures
with precise bit-level and byte-level fields,
using more ergonomic syntax.

## At a glance

Note that **Big-Endian / MSB-0** is used.

```rust
use bitx::bits;

bits! {
    pub struct Header: 4.4 { // size in `byte.bit` notation (so 36-bit)
        // 1-bit fields automatically return `bool`
        0.0 pub is_active: u1,

        // Custom bit-widths are supported
        0.1 pub status: u3,
        
        // The `.0` bit offset can be omitted.
        1 pub payload: u16,

        // Unaligned cross-byte field
        3.4 checksum: u8,
    }
}
```

```rust
use bitx::bits;

bits! {
    pub enum State: 0.2 { // 2-bit enum
        0 Inactive,
        1 Active,
        2 Error,
        _ Unknown, // Default fallback for unmapped bit patterns
    }
}
```

See [docs.rs](https://docs.rs/bitx/latest/bitx/macro.bits.html)
for more information.

## License

This project is licensed under either of

- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
  <https://www.apache.org/licenses/LICENSE-2.0>)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or
  <https://opensource.org/licenses/MIT>)

at your option.