Byte

A low-level, zero-copy and panic-free serializer and deserializer for binary.

Documentation

Usage

First, add the following to your Cargo.toml:

toml [dependencies] byte = "0.2"

Next, add this to your crate root:

rust extern crate byte;

Byte is no_std library; it can directly be used in a #![no_std] situation or crate.

Overview

Byte is designed to encode or decode binary data in a fast and low-level way. A classical use case is I2C communication en/decoding.

Byte provides two core traits TryRead and TryWrite. Types that implement these traits can be serialize into or deserialize from byte slices.

The library is meant to be simple, and it will always be.

Example

```rust use byte::*;

let bytes: &[u8] = &[0xde, 0xad, 0xbe, 0xef];

let offset = &mut 0; let num = bytes.readwith::(offset, BE).unwrap(); asserteq!(num, 0xdeadbeef); assert_eq!(*offset, 4); ```

```rust use byte::*; use byte::ctx::{Str, NULL};

let bytes: &[u8] = b"hello, world!\0dump";

let offset = &mut 0; let str = bytes.readwith::<&str>(offset, Str::Delimiter(NULL)).unwrap(); asserteq!(str, "hello, world!"); assert_eq!(*offset, 14); ```

Contribution

All kinds of contribution are welcomed.

• Issus. Feel free to open an issue when you find typos, bugs, or have any question.
• Pull requests. New collection, better implementation, more tests, more documents and typo fixes are all welcomed.

License

Licensed under MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)