bitcode

Bitcode

A binary encoder/decoder with the following goals:

• Blazingly fast
• Tiny serialized size
• Highly compressible by Deflate/LZ4/Zstd

In contrast, these are non-goals:

• Stable format across major versions
• Self describing format
• Compatibility with languages other than Rust

See rust_serialization_benchmark for benchmarks.

Example

use bitcode::{Encode, Decode};

#[derive(Encode, Decode, PartialEq, Debug)]
struct Foo {
    x: u32,
    y: &'a str,
}

let original = Foo {
    x: 10,
    y: "abc",
};

let encoded: Vec = bitcode::encode(&original); // No error
let decoded: Foo = bitcode::decode(&encoded).unwrap();
assert_eq!(original, decoded);

Adding Support for Libraries

See the instructions here!

Implementation Details

• Heavily inspired by
• All instances of each field are grouped together making compression easier
• Uses smaller integers where possible all the way down to 1 bit
• Validation is performed up front on typed vectors before deserialization
• Code is designed to be auto-vectorized by LLVM

serde

A serde integration is gated behind the "serde" feature flag. Click here to learn more.

#![no_std]

All std-only functionality is gated behind the (default) "std" feature.

alloc is required.

License

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE or )
• MIT license (LICENSE-MIT or )

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.