const-decoder

Crates.ioconst-decoder
lib.rsconst-decoder
version0.4.0
sourcesrc
created_at2021-04-16 13:55:24.368097
updated_at2024-09-29 16:50:01.684689
descriptionConstant functions for converting hex- and base64-encoded strings into bytes
homepage
repositoryhttps://github.com/slowli/const-decoder
max_upload_size
id385305
size60,355
Alex Ostrovski (slowli)

documentation

README

Constant Functions for Hex / Base64 Decoding

Build Status License: MIT OR Apache-2.0 rust 1.67+ required

Documentation: Docs.rs crate docs (master)

Constant functions for converting hex- and base64-encoded strings into bytes in Rust. Works on stable Rust and in no-std environments. Base-(2,4,8,16,32,64) encodings with custom alphabets are supported as well.

Usage

Add this to your Crate.toml:

[dependencies]
const-decoder = "0.4.0"

Example of usage:

use const_decoder::Decoder;
// An Ed25519 secret key.
const SECRET_KEY: [u8; 64] = Decoder::Hex.decode(
    b"9e55d1e1aa1f455b8baad9fdf975503655f8b359d542fa7e4ce84106d625b352\
      06fac1f22240cffd637ead6647188429fafda9c9cb7eae43386ac17f61115075",
);
// Alternatively, you can use `decode!` macro:
const PUBLIC_KEY: &[u8] = &const_decoder::decode!(
    Decoder::Hex,
    b"06fac1f22240cffd637ead6647188429fafda9c9cb7eae43386ac17f61115075",
);

Bech32 encoding:

use const_decoder::{Decoder, Encoding};
const BECH32: Decoder = Decoder::custom("qpzry9x8gf2tvdw0s3jn54khce6mua7l");
// Sample address from the Bech32 spec excluding the `tb1q` prefix
// and the checksum suffix.
const SAMPLE_ADDR: [u8; 32] =
    BECH32.decode(b"rp33g0q5c5txsp9arysrx4k6zdkfs4nce4xj0gdcccefvpysxf3q");

See more examples in the crate docs.

Alternatives

hex-literal and binary_macros crates expose similar functionality as procedural macros. Because of this, macros cannot be used in no-std environments, while this approach can.

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in const-decoder by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Commit count: 74

cargo fmt