#deku #bits #serialization #deserialization #struct

no-std deku

bit level serialization/deserialization proc-macro for structs

20 unstable releases (7 breaking)

0.12.4 Oct 11, 2021
0.12.3 Jul 6, 2021
0.12.2 Jun 15, 2021
0.11.0 Feb 25, 2021
0.1.2 Mar 30, 2020

#61 in Encoding

Download history 113/week @ 2021-07-01 235/week @ 2021-07-08 107/week @ 2021-07-15 63/week @ 2021-07-22 197/week @ 2021-07-29 140/week @ 2021-08-05 100/week @ 2021-08-12 90/week @ 2021-08-19 116/week @ 2021-08-26 56/week @ 2021-09-02 55/week @ 2021-09-09 182/week @ 2021-09-16 61/week @ 2021-09-23 32/week @ 2021-09-30 111/week @ 2021-10-07 237/week @ 2021-10-14

414 downloads per month
Used in 5 crates (4 directly)

MIT/Apache

220KB
4K 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.12"

no_std:

[dependencies]
deku = { version = "0.12", 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

~2MB
~45K SLoC