#hex-string #codec #base64 #hex #decoding #base-16 #constant-evaluation

no-std const-decoder

Constant functions for converting hex- and base64-encoded strings into bytes

4 releases (breaking)

new 0.4.0 Sep 29, 2024
0.3.0 Nov 1, 2022
0.2.0 Oct 10, 2021
0.1.0 Apr 16, 2021

#189 in Encoding

Download history 1143/week @ 2024-06-12 1343/week @ 2024-06-19 1427/week @ 2024-06-26 1766/week @ 2024-07-03 1299/week @ 2024-07-10 1183/week @ 2024-07-17 1791/week @ 2024-07-24 1544/week @ 2024-07-31 1496/week @ 2024-08-07 1569/week @ 2024-08-14 2308/week @ 2024-08-21 5257/week @ 2024-08-28 6639/week @ 2024-09-04 5762/week @ 2024-09-11 902/week @ 2024-09-18 879/week @ 2024-09-25

15,689 downloads per month
Used in 8 crates (7 directly)

MIT/Apache

34KB
587 lines

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.

Dependencies

~65KB