#serde #adapter #bytes #bytearray

serde-bytes-repr

Serde adapter for controlling the representation of bytes

7 releases

0.2.0 Oct 18, 2023
0.1.5 Feb 3, 2021
0.1.3 Nov 18, 2020
0.1.2 Jul 17, 2020

#179 in Encoding

Download history 4512/week @ 2023-11-01 4871/week @ 2023-11-08 5502/week @ 2023-11-15 4609/week @ 2023-11-22 4850/week @ 2023-11-29 4704/week @ 2023-12-06 4154/week @ 2023-12-13 1813/week @ 2023-12-20 1293/week @ 2023-12-27 2943/week @ 2024-01-03 2844/week @ 2024-01-10 3237/week @ 2024-01-17 2929/week @ 2024-01-24 3427/week @ 2024-01-31 3296/week @ 2024-02-07 3220/week @ 2024-02-14

13,434 downloads per month
Used in 10 crates (6 directly)

MIT license

42KB
1K SLoC

Serde adapter for controlling the representation of bytes

Build Status

Human readable formats tend not to include a universally agreed way to represent arbitrary binary data, which means those serde libraries can end up using a representation for serde's "bytes" type which isn't ideal for all uses.

// [dependencies]
// serde = { version = "1.0", features = ["derive"] }
// serde_bytes = "0.11"
// serde_json = "1.0"
// serde_yaml = "0.8"
// toml = "0.5"

use serde::Serialize;

#[derive(Serialize)]
struct Demo {
    #[serde(with = "serde_bytes")]
    bytes: Vec<u8>,
}

fn main() {
    let bytes = b"testing".to_vec();
    let s = Demo { bytes };

    println!("JSON: {}", serde_json::to_string(&s).unwrap());
    println!("YAML: {}", serde_yaml::to_string(&s).unwrap());
    println!("TOML: {}", toml::to_string(&s).unwrap());
}
JSON: {"bytes":[116,101,115,116,105,110,103]}
YAML: ---
bytes:
  - 116
  - 101
  - 115
  - 116
  - 105
  - 110
  - 103
TOML: bytes = [116, 101, 115, 116, 105, 110, 103]

This adapter lets you control how the bytes are represented by wrapping a serializer like this:

#[derive(Serialize, Deserialize)]
struct Demo {
    #[serde(with = "serde_bytes")]
    bytes: Vec<u8>,
}

fn main() {
    let bytes = b"testing".to_vec();
    let demo = Demo { bytes };

    let mut out = vec![];
    let mut ser = serde_json::Serializer::new(&mut out);
    let base64_config = base64::Config::new(base64::CharacterSet::UrlSafe, true);
    let ser = BytesRepr::base64(&mut ser, base64_config);
    demo.serialize(ser).unwrap();

    let serialized = String::from_utf8(out).unwrap();
    println!("JSON(base64): {}", serialized);
}

Outputs:

JSON(base64): {"bytes":"dGVzdGluZw=="}

Dependencies

~325–600KB
~12K SLoC