#serde #hex #encoding #bytes

no-std hex-buffer-serde

Helper for serializing byte buffers as hex strings in serde

6 releases

new 0.3.0 May 3, 2021
0.2.2 Dec 5, 2020
0.2.1 Mar 15, 2020
0.2.0 Apr 15, 2019
0.1.1 Nov 30, 2018

#90 in Encoding

Download history 613/week @ 2021-01-13 152/week @ 2021-01-20 136/week @ 2021-01-27 132/week @ 2021-02-03 138/week @ 2021-02-10 145/week @ 2021-02-17 114/week @ 2021-02-24 180/week @ 2021-03-03 134/week @ 2021-03-10 102/week @ 2021-03-17 490/week @ 2021-03-24 228/week @ 2021-03-31 98/week @ 2021-04-07 192/week @ 2021-04-14 113/week @ 2021-04-21 132/week @ 2021-04-28

727 downloads per month
Used in 25 crates (6 directly)

Apache-2.0

31KB
423 lines

Hex encoding helper for serde

Build Status License: Apache-2.0 rust 1.41.0+ 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.3.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.

Supported Rust Versions

The hex-buffer-serde crate is built against recent stable Rust versions. The minimum of these versions is indicated in the badge at the top of this file. The const_len crate feature requires a newer Rust version (1.51+), but it is disabled by default.

A bump of the minimum supported Rust version will not be considered a semantically breaking change. It is, however, guaranteed that the crate will build on some stable Rust toolchain.

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.

License

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

Dependencies

~170–290KB