Struct Encoding

pub struct Encoding { /* private fields */ }

Custom encoding scheme based on a certain alphabet (mapping between a subset of ASCII chars and digits in 0..P, where P is a power of 2).

Examples

// Decoder for Bech32 encoding as specified in
// https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki.
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");

Implementations

impl Encoding

pub const fn new(alphabet: &'static str) -> Self

Creates an encoding based on the provided alphabet: a sequence of ASCII chars that correspond to digits 0, 1, 2, etc.

Panics

• Panics if alphabet does not consist of distinct ASCII chars.
• Panics if alphabet length is not 2, 4, 8, 16, 32 or 64.

Trait Implementations

impl Clone for Encoding

fn clone(&self) -> Encoding

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Encoding

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Copy for Encoding