cs_serde_bytes

Crates.iocs_serde_bytes
lib.rscs_serde_bytes
version0.12.2
sourcesrc
created_at2020-12-03 22:18:53.198636
updated_at2022-08-31 12:37:30.249153
descriptionOptimized handling of `&[u8]` and `Vec` for Serde
homepage
repositoryhttps://github.com/ChainSafe/serde-bytes
max_upload_size
id319460
size41,704
David Himmelstrup (lemmih)

documentation

README

cs_serde_bytes Build Status Latest Version

Disclaimer

This crate is fork of serde_bytes. The only differrence from the upstream is intentional no support for strings as bytes, making it more strict.

[dependencies]
cs_serde_bytes = "0.12.1"

Explanation

Without specialization, Rust forces Serde to treat &[u8] just like any other slice and Vec<u8> just like any other vector. In reality this particular slice and vector can often be serialized and deserialized in a more efficient, compact representation in many formats.

When working with such a format, you can opt into specialized handling of &[u8] by wrapping it in serde_bytes::Bytes and Vec<u8> by wrapping it in serde_bytes::ByteBuf.

Additionally this crate supports the Serde with attribute to enable efficient handling of &[u8] and Vec<u8> in structs without needing a wrapper type.

Example

use serde::{Deserialize, Serialize};

#[derive(Deserialize, Serialize)]
struct Efficient<'a> {
    #[serde(with = "serde_bytes")]
    bytes: &'a [u8],

    #[serde(with = "serde_bytes")]
    byte_buf: Vec<u8>,
}

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
Commit count: 109

cargo fmt