14 releases

0.1.14 Nov 21, 2023
0.1.13 May 20, 2023
0.1.12 May 27, 2021
0.1.10 Nov 2, 2020
0.1.1 Nov 18, 2017

#258 in Encoding

Download history 86657/week @ 2023-11-21 92112/week @ 2023-11-28 83950/week @ 2023-12-05 76548/week @ 2023-12-12 65108/week @ 2023-12-19 40162/week @ 2023-12-26 66810/week @ 2024-01-02 82672/week @ 2024-01-09 88950/week @ 2024-01-16 88511/week @ 2024-01-23 94776/week @ 2024-01-30 99358/week @ 2024-02-06 98159/week @ 2024-02-13 106205/week @ 2024-02-20 99864/week @ 2024-02-27 79347/week @ 2024-03-05

404,378 downloads per month
Used in 758 crates (19 directly)

MIT license

125KB
1.5K SLoC

This library provides macros to define compile-time byte slices and arrays from encoded strings (using common bases like base64, base32, or hexadecimal, and also custom bases). It also provides a macro to define compile-time custom encodings to be used with the data-encoding crate.

See the documentation for more details.

Up to Rust 1.50, you may need to add the following to your .cargo/config.toml to use this library in no-std or no-alloc environments:

[unstable]
features = ["host_dep"]

From Rust 1.51, you may need to add the following to your Cargo.toml:

[package]
resolver = "2"

lib.rs:

Macros for data-encoding

This library provides macros to define compile-time byte arrays from encoded strings (using common bases like base64, base32, or hexadecimal, and also custom bases). It also provides a macro to define compile-time custom encodings to be used with the data-encoding crate at run-time.

Up to Rust 1.50, you may need to add the following to your .cargo/config.toml to use this library in no-std or no-alloc environments:

[unstable]
features = ["host_dep"]

From Rust 1.51, you may need to add the following to your Cargo.toml:

[package]
resolver = "2"

Examples

You can define a compile-time byte slice from an encoded string literal:

const HELLO_SLICE: &'static [u8] = &data_encoding_macro::hexlower!("68656c6c6f");
const FOOBAR_SLICE: &'static [u8] = &data_encoding_macro::base64!("Zm9vYmFy");

You can also define a compile-time byte array from an encoded string literal:

data_encoding_macro::hexlower_array!("const HELLO" = "68656c6c6f");
data_encoding_macro::base64_array!("const FOOBAR" = "Zm9vYmFy");

You can define a compile-time custom encoding from its specification:

const HEX: data_encoding::Encoding = data_encoding_macro::new_encoding! {
    symbols: "0123456789abcdef",
    translate_from: "ABCDEF",
    translate_to: "abcdef",
};
const BASE64: data_encoding::Encoding = data_encoding_macro::new_encoding! {
    symbols: "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/",
    padding: '=',
};

Dependencies

~1.5MB
~33K SLoC