serde-byte-array

Crates.ioserde-byte-array
lib.rsserde-byte-array
version0.1.2
sourcesrc
created_at2023-02-24 09:45:41.320013
updated_at2023-02-27 10:58:47.583283
descriptionOptimized handling of `[u8; N]` for Serde
homepage
repositoryhttps://github.com/nitrokey/serde-byte-array
max_upload_size
id793441
size33,559
Crate owners (github:nitrokey:crate-owners)

documentation

README

serde_byte_array

Wrapper types to enable optimized handling of [u8; N]

Explanation

Without specialization, Rust forces Serde to treat [u8; N] just like any other arary In reality this particular array 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; N] by wrapping it in serde_byte_array::ByteArray<N>.

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

Example

use serde::{Deserialize, Serialize};

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

    #[serde(with = "serde_byte_array", borrow)]
    bytes_ref: &'a [u8; 3],
}

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: 16

cargo fmt