#deku #bits #serialization #deserialization #struct

no-std deku

bit level serialization/deserialization proc-macro for structs

26 releases (11 breaking)

0.16.0 Feb 28, 2023
0.15.1 Dec 19, 2022
0.15.0 Nov 16, 2022
0.13.1 Jun 9, 2022
0.1.2 Mar 30, 2020

#61 in Rust patterns

Download history 907/week @ 2023-02-05 915/week @ 2023-02-12 1173/week @ 2023-02-19 784/week @ 2023-02-26 1038/week @ 2023-03-05 1282/week @ 2023-03-12 1802/week @ 2023-03-19 1476/week @ 2023-03-26 1266/week @ 2023-04-02 1233/week @ 2023-04-09 1626/week @ 2023-04-16 1560/week @ 2023-04-23 1781/week @ 2023-04-30 1762/week @ 2023-05-07 1736/week @ 2023-05-14 1802/week @ 2023-05-21

7,140 downloads per month
Used in 22 crates (18 directly)

MIT/Apache

155KB
2.5K SLoC

Deku

Latest Version Rust Documentation Actions Status codecov Gitter

Declarative binary reading and writing

This crate provides bit-level, symmetric, serialization/deserialization implementations for structs and enums

Why use Deku

Productivity: Deku will generate symmetric reader/writer functions for your type! Avoid the requirement of writing redundant, error-prone parsing and writing code for binary structs or network headers

Usage

[dependencies]
deku = "0.16"

no_std:

[dependencies]
deku = { version = "0.16", default-features = false, features = ["alloc"] }

Example

See documentation or examples folder for more!

Read big-endian data into a struct, modify a value, and write it

use deku::prelude::*;

#[derive(Debug, PartialEq, DekuRead, DekuWrite)]
#[deku(endian = "big")]
struct DekuTest {
    #[deku(bits = "4")]
    field_a: u8,
    #[deku(bits = "4")]
    field_b: u8,
    field_c: u16,
}

fn main() {
    let data: Vec<u8> = vec![0b0110_1001, 0xBE, 0xEF];
    let (_rest, mut val) = DekuTest::from_bytes((data.as_ref(), 0)).unwrap();
    assert_eq!(DekuTest {
        field_a: 0b0110,
        field_b: 0b1001,
        field_c: 0xBEEF,
    }, val);

    val.field_c = 0xC0FE;

    let data_out = val.to_bytes().unwrap();
    assert_eq!(vec![0b0110_1001, 0xC0, 0xFE], data_out);
}

Changelog

See CHANGELOG.md

Dependencies

~2.5MB
~64K SLoC