A binary encoder/decoder for Rust
- Rust 100%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
Balazs Horvath
18f3bb551f
Un-pins four dependencies so they follow their forks' default branches instead of a registry version that will drift from them. glam gains scalar-math, which the fork needs and the registry release did not expose under this feature set. Verified with the default feature set: 69 tests pass. The opt-in unstable_bench feature does not build, for two independent reasons, both recorded in the follow-up todo rather than papered over here -- rand_chacha was never a declared dependency so that feature was already broken, and lz4_flex 0.14 moved compress_prepend_size behind alloc and deprecated it, which the default-features = false dev-dependency hides. |
||
| .cargo | ||
| bitcode_derive | ||
| fuzz | ||
| src | ||
| .gitignore | ||
| Cargo.toml | ||
| LICENSE-MIT | ||
| README.md | ||
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<'a> {
x: u32,
y: &'a str,
}
let original = Foo {
x: 10,
y: "abc",
};
let encoded: Vec<u8> = 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 https://github.com/That3Percent/tree-buf
- 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 http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
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.