https://github.com/slowli/hex-buffer-serde

Serializing byte buffers as hex strings with `serde`
https://github.com/slowli/hex-buffer-serde

encoding hexadecimal serde

Last synced: 2 months ago
JSON representation

Serializing byte buffers as hex strings with `serde`

• Host: GitHub
• URL: https://github.com/slowli/hex-buffer-serde
• Owner: slowli
• License: apache-2.0
• Created: 2018-11-27T12:54:08.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-10-11T03:34:12.000Z (3 months ago)
• Last Synced: 2024-10-14T10:53:48.806Z (3 months ago)
• Topics: encoding, hexadecimal, serde
• Language: Rust
• Size: 1.16 MB
• Stars: 4
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Hex encoding helper for serde

[![Build Status](https://github.com/slowli/hex-buffer-serde/workflows/CI/badge.svg?branch=master)](https://github.com/slowli/hex-buffer-serde/actions) 

[![License: Apache-2.0](https://img.shields.io/github/license/slowli/hex-buffer-serde.svg)](https://github.com/slowli/hex-buffer-serde/blob/master/LICENSE)

![rust 1.70+ required](https://img.shields.io/badge/rust-1.70+-blue.svg?label=Required%20Rust)

**Documentation:** [![Docs.rs](https://docs.rs/hex-buffer-serde/badge.svg)](https://docs.rs/hex-buffer-serde/) 

[![crate docs (master)](https://img.shields.io/badge/master-yellow.svg?label=docs)](https://slowli.github.io/hex-buffer-serde/hex_buffer_serde/)

`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`:

```toml

[dependencies]

hex-buffer-serde = "0.4.0"

```

Basic usage:

```rust

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](LICENSE) for details.

[`hex-serde`]: https://crates.io/crates/hex-serde

[`serde-with`]: https://crates.io/crates/serde-with