bitsandbytes 0.1.0

An owned, bit-aware binary codec: fast bit/byte field types and the unified #[bin] macro.
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

//! `bytes` integration (ROADMAP Phase 3, the `bytes` feature): zero-copy
//! `BytesReader`/`BytesWriter`. Decode from an owned `Bytes` frame; encode into a
//! writer you `freeze()` to a `Bytes` — the async/tokio framing path.
#![cfg(feature = "bytes")]

use bnb::{BitEncode, BytesReader, BytesWriter, bin, u4, u12};

#[bin]
#[derive(Debug, PartialEq, Eq, Clone)]
struct Frame {
    a: u4,
    b: u12,
}

#[test]
fn round_trip_through_bytes() {
    let f = Frame {
        a: u4::new(0xA),
        b: u12::new(0x123),
    };

    // Encode into a BytesWriter, then freeze to a zero-copy Bytes.
    let mut w = BytesWriter::new();
    f.bit_encode(&mut w).unwrap();
    let frozen = w.freeze();
    assert_eq!(&frozen[..], &[0xA1, 0x23]);

    // Decode from an owned Bytes via BytesReader.
    let mut r = BytesReader::new(frozen.clone());
    let decoded = Frame::decode_from(&mut r).unwrap();
    assert_eq!(decoded, f);
}