Struct bs58::decode::DecodeBuilder

pub struct DecodeBuilder<'a, I: AsRef<[u8]>> { /* fields omitted */ }

A builder for setting up the alphabet and output of a base58 decode.

See the documentation for bs58::decode for a more high level view of how to use this.

Methods

impl<'a, I: AsRef<[u8]>> DecodeBuilder<'a, I>

pub fn new(input: I, alpha: &'a [u8; 58]) -> DecodeBuilder<'a, I>

Setup decoder for the given string using the given alphabet. Preferably use bs58::decode instead of this directly.

pub fn with_alphabet(self, alpha: &'a [u8; 58]) -> DecodeBuilder<'a, I>

Change the alphabet that will be used for decoding.

Examples

assert_eq!(
    vec![0x60, 0x65, 0xe7, 0x9b, 0xba, 0x2f, 0x78],
    bs58::decode("he11owor1d")
        .with_alphabet(bs58::alphabet::RIPPLE)
        .into_vec().unwrap());

pub fn with_prepared_alphabet(self, alpha: &'a Alphabet) -> DecodeBuilder<'a, I>

Change the alphabet that will be used for decoding.

Examples

assert_eq!(
    vec![0x60, 0x65, 0xe7, 0x9b, 0xba, 0x2f, 0x78],
    bs58::decode("he11owor1d")
        .with_prepared_alphabet(bs58::Alphabet::RIPPLE)
        .into_vec().unwrap());

pub fn with_check(self, expected_ver: Option<u8>) -> DecodeBuilder<'a, I>

This is supported on feature="check" only.

Expect and check checksum using the Base58Check algorithm when decoding.

Optional parameter for version byte. If provided, the version byte will be used in verification.

Examples

assert_eq!(
    vec![0x2d, 0x31],
    bs58::decode("PWEu9GGN")
        .with_check(None)
        .into_vec().unwrap());

pub fn into_vec(self) -> Result<Vec<u8>>

This is supported on feature="alloc" or feature="std" only.

Decode into a new vector of bytes.

See the documentation for bs58::decode for an explanation of the errors that may occur.

Examples

assert_eq!(
    vec![0x04, 0x30, 0x5e, 0x2b, 0x24, 0x73, 0xf0, 0x58],
    bs58::decode("he11owor1d").into_vec().unwrap());

pub fn into<O: AsMut<[u8]>>(self, output: O) -> Result<usize>

Decode into the given buffer.

Returns the length written into the buffer, the rest of the bytes in the buffer will be untouched.

See the documentation for bs58::decode for an explanation of the errors that may occur.

Examples

let mut output = [0xFF; 10];
assert_eq!(8, bs58::decode("he11owor1d").into(&mut output).unwrap());
assert_eq!(
    [0x04, 0x30, 0x5e, 0x2b, 0x24, 0x73, 0xf0, 0x58, 0xFF, 0xFF],
    output);