https://github.com/serde-rs/bytes

Wrapper types to enable optimized handling of &[u8] and Vec<u8>
https://github.com/serde-rs/bytes

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/serde-rs/bytes
• Owner: serde-rs
• License: apache-2.0
• Created: 2017-04-05T21:31:15.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2025-03-09T20:51:27.000Z (3 months ago)
• Last Synced: 2025-04-11T00:52:22.044Z (2 months ago)
• Language: Rust
• Homepage:
• Size: 234 KB
• Stars: 338
• Watchers: 7
• Forks: 37
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# serde\_bytes [![Build Status](https://img.shields.io/github/actions/workflow/status/serde-rs/bytes/ci.yml?branch=master)](https://github.com/serde-rs/bytes/actions?query=branch%3Amaster) [![Latest Version](https://img.shields.io/crates/v/serde_bytes.svg)](https://crates.io/crates/serde_bytes)

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

```toml

[dependencies]

serde_bytes = "0.11"

```

## Explanation

Without specialization, Rust forces Serde to treat `&[u8]` just like any

other slice and `Vec` 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` by wrapping it

in `serde_bytes::ByteBuf`.

Additionally this crate supports the Serde `with` attribute to enable efficient

handling of `&[u8]` and `Vec` in structs without needing a wrapper type.

## Example

```rust

use serde::{Deserialize, Serialize};

#[derive(Deserialize, Serialize)]

struct Efficient<'a> {

    #[serde(with = "serde_bytes")]

    bytes: &'a [u8],

    #[serde(with = "serde_bytes")]

    byte_buf: Vec,

}

```




#### 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.