Hex encoding helper for serde

Documentation:

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.2.2"

See crate docs for the examples of usage.

Crate Features

std (enabled by default): Enables types from the Rust standard library. Switching this feature off can be used for constrained environments, such as WASM. Note that the crate still requires an allocator (that is, the alloc crate) even if the std feature is disabled.

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. Newer stable versions are supported as a result. Recent beta and nightly versions should be supported as well, but no specific effort is allocated into supporting them.

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