Struct bs58::encode::EncodeBuilder

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

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

Implementations

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

pub fn new(input: I, alpha: &'a Alphabet) -> EncodeBuilder<'a, I>

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

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

Change the alphabet that will be used for encoding.

Examples

let input = [0x60, 0x65, 0xe7, 0x9b, 0xba, 0x2f, 0x78];
assert_eq!(
    "he11owor1d",
    bs58::encode(input)
        .with_alphabet(bs58::Alphabet::RIPPLE)
        .into_string());

pub fn with_check(self) -> EncodeBuilder<'a, I>

Available on crate feature check only.

Include checksum calculated using the Base58Check algorithm when encoding.

Examples

let input = [0x60, 0x65, 0xe7, 0x9b, 0xba, 0x2f, 0x78];
assert_eq!(
    "QuT57JNzzWTu7mW",
    bs58::encode(input)
        .with_check()
        .into_string());

pub fn with_check_version(self, expected_ver: u8) -> EncodeBuilder<'a, I>

Available on crate feature check only.

Include checksum calculated using the Base58Check algorithm and version when encoding.

Examples

let input = [0x60, 0x65, 0xe7, 0x9b, 0xba, 0x2f, 0x78];
assert_eq!(
    "oP8aA4HEEyFxxYhp",
    bs58::encode(input)
        .with_check_version(42)
        .into_string());

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

Available on crate feature cb58 only.

Include checksum calculated using the CB58 algorithm and version (if specified) when encoding.

Examples

let input = [0x60, 0x65, 0xe7, 0x9b, 0xba, 0x2f, 0x78];
assert_eq!(
    "oP8aA4HEEyChXhM2",
    bs58::encode(input)
        .as_cb58(Some(42))
        .into_string());

pub fn into_string(self) -> String

Available on crate feature alloc only.

Encode into a new owned string.

Examples

let input = [0x04, 0x30, 0x5e, 0x2b, 0x24, 0x73, 0xf0, 0x58];
assert_eq!("he11owor1d", bs58::encode(input).into_string());

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

Available on crate feature alloc only.

Encode into a new owned vector.

Examples

let input = [0x04, 0x30, 0x5e, 0x2b, 0x24, 0x73, 0xf0, 0x58];
assert_eq!(b"he11owor1d", &*bs58::encode(input).into_vec());

pub fn onto(self, output: impl EncodeTarget) -> Result<usize>

Encode onto the given buffer.

Returns the length written onto the buffer.

If the buffer is resizeable it will be extended and the new data will be written to the end of it, otherwise the data will be overwritten from the start.

If the buffer is not resizeable bytes after the final character will be left alone, except up to 3 null bytes may be written to an &mut str to overwrite remaining characters of a partially overwritten multi-byte character.

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

Examples

Vec<u8>

let input = [0x04, 0x30, 0x5e, 0x2b, 0x24, 0x73, 0xf0, 0x58];
let mut output = b"goodbye world ".to_vec();
bs58::encode(input).onto(&mut output)?;
assert_eq!(b"goodbye world he11owor1d", output.as_slice());

&mut [u8]

let input = [0x04, 0x30, 0x5e, 0x2b, 0x24, 0x73, 0xf0, 0x58];
let mut output = b"goodbye world".to_owned();
bs58::encode(input).onto(&mut output[..])?;
assert_eq!(b"he11owor1drld", output.as_ref());

String

let input = [0x04, 0x30, 0x5e, 0x2b, 0x24, 0x73, 0xf0, 0x58];
let mut output = "goodbye world ".to_owned();
bs58::encode(input).onto(&mut output)?;
assert_eq!("goodbye world he11owor1d", output);

&mut str

let input = [0x04, 0x30, 0x5e, 0x2b, 0x24, 0x73, 0xf0, 0x58];
let mut output = "goodbye world".to_owned();
bs58::encode(input).onto(output.as_mut_str())?;
assert_eq!("he11owor1drld", output);

Clearing partially overwritten characters

let input = [0x04, 0x30, 0x5e, 0x2b, 0x24, 0x73, 0xf0, 0x58];
let mut output = "goodbye w®ld".to_owned();
bs58::encode(input).onto(output.as_mut_str())?;
assert_eq!("he11owor1d\0ld", output);