2 releases

0.1.1 Nov 23, 2024
0.1.0 Nov 11, 2024

#1263 in Encoding

Download history 125/week @ 2024-11-11 141/week @ 2024-11-18 37/week @ 2024-11-25 44/week @ 2024-12-02 52/week @ 2024-12-09

279 downloads per month

MIT/Apache

37KB
988 lines

serde-human-bytes

A fork of serde_bytes that serialize bytes to hex string when the format is human readable.

[dependencies]
serde-human-bytes = "0.1"

Example

use serde::{Deserialize, Serialize};

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

    #[serde(with = "serde_human_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.

lib.rs:

Wrapper types to enable optimized handling of &[u8] and Vec<u8>.

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_human_bytes::Bytes and Vec<u8> by wrapping it in serde_human_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.

use serde::{Deserialize, Serialize};

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

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

    #[serde(with = "serde_human_bytes")]
    byte_array: [u8; 314],
}

Dependencies

~120–350KB