mirror of https://git.sr.ht/~stygianentity/bincode
38 lines
863 B
Markdown
38 lines
863 B
Markdown
# Binary Encoder / Decoder
|
|
|
|
A compact encoder / decoder pair that uses an binary zero-fluff encoding scheme.
|
|
The size of the encoded object will be the same or smaller than the size that
|
|
the object takes up in memory in a running Rust program.
|
|
|
|
[Api Documentation](http://tyoverby.github.io/binary-encode/binary_encode/)
|
|
|
|
## Example
|
|
|
|
```rust
|
|
extern crate binary_encode;
|
|
extern crate serialize;
|
|
|
|
#[deriving(Encodable, Decodable, PartialEq)]
|
|
struct Entity {
|
|
x: f32,
|
|
y: f32,
|
|
}
|
|
|
|
#[deriving(Encodable, Decodable, PartialEq)]
|
|
struct World {
|
|
entities: Vec<Entity>
|
|
}
|
|
|
|
fn main() {
|
|
let world = World {
|
|
entities: vec![Entity {x: 0.0, y: 4.0}, Entity {x: 10.0, y: 20.5}]
|
|
};
|
|
|
|
let encoded: Vec<u8> = binary_encode::encode(&world).unwrap();
|
|
let decoded: World = binary_encode::decode(encoded).unwrap();
|
|
|
|
assert!(world == decoded);
|
|
}
|
|
|
|
```
|