Expand description
Bincode is a crate for encoding and decoding using a tiny binary serialization strategy. Using it, you can easily go from having an object in memory, quickly serialize it to bytes, and then deserialize it back just as fast!
§Using Basic Functions
ⓘ
fn main() {
// The object that we will serialize.
let target: Option<String> = Some("hello world".to_string());
let encoded: Vec<u8> = bincode::serialize(&target).unwrap();
let decoded: Option<String> = bincode::deserialize(&encoded[..]).unwrap();
assert_eq!(target, decoded);
}
§128bit numbers
Support for i128
and u128
is automatically enabled on Rust toolchains
greater than or equal to 1.26.0
and disabled for targets which do not support it
Re-exports§
pub use config::Config;
Deprecated pub use config::DefaultOptions;
pub use config::Options;
pub use de::read::BincodeRead;
pub use de::Deserializer;
Modules§
- config
bincode
uses a Builder-pattern to configure the Serializers and Deserializers in this crate. This means that if you need to customize the behavior ofbincode
, you should create an instance of theDefaultOptions
struct:- de
- Deserialize bincode data to a Rust data structure.
Structs§
- Serializer
- An Serializer that encodes values directly into a Writer.
Enums§
- Error
Kind - The kind of error that can be produced during a serialization or deserialization.
Functions§
- config
Deprecated - Get a default configuration object.
- deserialize
- Deserializes a slice of bytes into an instance of
T
using the default configuration. - deserialize_
from - Deserializes an object directly from a
Read
er using the default configuration. - deserialize_
from_ custom - Deserializes an object from a custom
BincodeRead
er using the default configuration. It is highly recommended to usedeserialize_from
unless you need to implementBincodeRead
for performance reasons. - options
- Get a default configuration object.
- serialize
- Serializes a serializable object into a
Vec
of bytes using the default configuration. - serialize_
into - Serializes an object directly into a
Writer
using the default configuration. - serialized_
size - Returns the size that an object would be if serialized using Bincode with the default configuration.