https://github.com/sharksforarms/deku

Declarative binary reading and writing: bit-level, symmetric, serialization/deserialization
https://github.com/sharksforarms/deku

bits bytes declarative deku deserialization encoder-decoder parse rust rust-crate serialization symmetric

Last synced: 15 days ago
JSON representation

Declarative binary reading and writing: bit-level, symmetric, serialization/deserialization

• Host: GitHub
• URL: https://github.com/sharksforarms/deku
• Owner: sharksforarms
• License: apache-2.0
• Created: 2020-03-18T15:55:42.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T18:16:33.000Z (15 days ago)
• Last Synced: 2024-10-29T20:23:39.583Z (15 days ago)
• Topics: bits, bytes, declarative, deku, deserialization, encoder-decoder, parse, rust, rust-crate, serialization, symmetric
• Language: Rust
• Homepage:
• Size: 990 KB
• Stars: 1,128
• Watchers: 8
• Forks: 55
• Open Issues: 63
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE-APACHE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-bytecode - Deku: a declarative binary reading and writing: bit-level, symmetric, serialization/deserialization library

README

        
# Deku

[![Latest Version](https://img.shields.io/crates/v/deku.svg)](https://crates.io/crates/deku)

[![Rust Documentation](https://docs.rs/deku/badge.svg)](https://docs.rs/deku)

[![Actions Status](https://github.com/sharksforarms/deku/workflows/CI/badge.svg)](https://github.com/sharksforarms/deku/actions)

[![codecov](https://codecov.io/gh/sharksforarms/deku/branch/master/graph/badge.svg)](https://codecov.io/gh/sharksforarms/deku)

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

*Compiler support: requires rustc 1.71+*

```toml

[dependencies]

deku = "0.18"

```

no_std:

```toml

[dependencies]

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

```

## Example

See [documentation](https://docs.rs/deku) or

[examples](https://github.com/sharksforarms/deku/tree/master/examples) folder for more!

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

```rust

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 = 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](https://github.com/sharksforarms/deku/blob/master/CHANGELOG.md)