#serde #hex #bytes

no-std hex-buffer-serde

Helper for serializing byte buffers as hex strings in serde

7 unstable releases

0.4.0 Nov 1, 2022
0.3.0 May 3, 2021
0.2.2 Dec 5, 2020
0.2.1 Mar 15, 2020
0.1.1 Nov 30, 2018

#1406 in Encoding

Download history 1083/week @ 2023-11-03 1181/week @ 2023-11-10 1297/week @ 2023-11-17 1394/week @ 2023-11-24 1304/week @ 2023-12-01 1482/week @ 2023-12-08 1147/week @ 2023-12-15 880/week @ 2023-12-22 980/week @ 2023-12-29 1219/week @ 2024-01-05 1248/week @ 2024-01-12 1560/week @ 2024-01-19 1255/week @ 2024-01-26 1334/week @ 2024-02-02 1643/week @ 2024-02-09 1169/week @ 2024-02-16

5,630 downloads per month
Used in 34 crates (8 directly)

Apache-2.0

32KB
425 lines

Hex encoding helper for serde

Build Status License: Apache-2.0 rust 1.57+ required

Documentation: Docs.rs crate docs (master)

hex-buffer-serde is a helper crate allowing to serialize types, which logically correspond to a byte buffer, in hex encoding within serde.

Usage

Add this to your Crate.toml:

[dependencies]
hex-buffer-serde = "0.4.0"

Basic usage:

use hex_buffer_serde::{Hex as _, HexForm};
use serde_derive::{Deserialize, Serialize};

#[derive(Serialize, Deserialize)]
pub struct Example {
    // will be serialized as hex string in human-readable formats
    // (e.g., JSON or TOML), and as a byte array in binary formats
    // (e.g., bincode).
    #[serde(with = "HexForm")]
    buffer: [u8; 32],
    // other fields...
}

See crate docs for more examples of usage.

Alternatives

hex-serde provides similar functionality and is a viable alternative if you have the control over the type that needs hex-encoding. This crate differs from hex-serde in the following ways:

  • You don't need control over the (de)serialized type; it does not need to implement any specific "useful" traits (such as AsRef<[u8]>).
  • Hex encoding is used only with human-readable (de)serializers (e.g., JSON or TOML). If the (de)serializer is not human-readable (e.g., bincode), the type is serialized as a byte array.

serde-with also provides hex encoding / decoding functionality with similar constraints to hex-serde.

License

hex-buffer-serde is licensed under the Apache License (Version 2.0). See LICENSE for details.

Dependencies

~130–380KB