https://github.com/cfsamson/rfi-serde-byte-repr
An implementation for https://github.com/dtolnay/request-for-implementation/issues/48
https://github.com/cfsamson/rfi-serde-byte-repr
Last synced: 3 months ago
JSON representation
An implementation for https://github.com/dtolnay/request-for-implementation/issues/48
- Host: GitHub
- URL: https://github.com/cfsamson/rfi-serde-byte-repr
- Owner: cfsamson
- License: mit
- Created: 2020-06-23T10:54:51.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-12-04T22:35:41.000Z (6 months ago)
- Last Synced: 2025-02-28T05:56:26.474Z (3 months ago)
- Language: Rust
- Size: 2.24 MB
- Stars: 5
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Serde adapter for controlling the representation of bytes
[](https://github.com/cfsamson/rfi-serde-byte-repr/actions/workflows/rust.yml)
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.
```rust
// [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,
}
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:
```rust
#[derive(Serialize, Deserialize)]
struct Demo {
#[serde(with = "serde_bytes")]
bytes: Vec,
}
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::engine::GeneralPurposeConfig::new();
let ser = ByteFmtSerializer::base64(&mut ser, base64::alphabet::URL_SAFE, base64_config);
demo.serialize(ser).unwrap();
let serialized = String::from_utf8(out).unwrap();
println!("JSON(base64): {}", serialized);
}
```
Outputs:
```
JSON(base64): {"bytes":"dGVzdGluZw=="}
```