17 releases

0.1.17 Feb 9, 2025
0.1.15 Apr 28, 2024
0.1.14 Nov 21, 2023
0.1.13 May 20, 2023
0.1.1 Nov 18, 2017

#347 in Encoding

Download history 155425/week @ 2024-11-23 166939/week @ 2024-11-30 201711/week @ 2024-12-07 208286/week @ 2024-12-14 72819/week @ 2024-12-21 103024/week @ 2024-12-28 214421/week @ 2025-01-04 288619/week @ 2025-01-11 279796/week @ 2025-01-18 322083/week @ 2025-01-25 335777/week @ 2025-02-01 364320/week @ 2025-02-08 276716/week @ 2025-02-15 244634/week @ 2025-02-22 560130/week @ 2025-03-01 407344/week @ 2025-03-08

1,548,440 downloads per month
Used in 1,032 crates (21 directly)

MIT license

135KB
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

~200–630KB
~15K SLoC