Struct bech32::Bech32

pub struct Bech32 { /* fields omitted */ }

Grouping structure for the human-readable part and the data part of decoded Bech32 string.

Please note that in contrast to the standard this library does not enforce a maximum length for bech32 encoded data. Please make sure to stay inside the parameters to ensure error detection.

Methods

impl Bech32

pub fn new(hrp: String, data: Vec<u5>) -> Result<Bech32, Error>

Constructs a Bech32 struct if the result can be encoded as a bech32 string.

Errors

• MixedCase: if the HRP contains upper case letters. Encoders must use lower case.
• InvalidChar: if the HRP contains any non-ASCII characters (outside 33..=126)
• InvalidLength: if the HRP is outside 1..83 characters long

Deviations from standard

• No length limits are enforced for the data part

pub fn new_check_data(hrp: String, data: Vec<u8>) -> Result<Bech32, Error>

Constructs a Bech32 struct if the result can be encoded as a bech32 string. It uses data that is not range checked yet and as a result may return Err(Error::InvalidData).

This function currently allocates memory for the checked data part. See issue #19.

pub fn hrp(&self) -> &str

Returns the human readable part

pub fn data(&self) -> &[u5]

Returns the data part as [u8] but only using 5 bits per byte

pub fn into_parts(self) -> (String, Vec<u5>)

Destructures the Bech32 struct into its parts

Trait Implementations

impl Eq for Bech32

impl PartialOrd<Bech32> for Bech32

fn partial_cmp(&self, other: &Bech32) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Bech32) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Bech32) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Bech32) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Bech32) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialEq<Bech32> for Bech32

fn eq(&self, other: &Bech32) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Bech32) -> bool

This method tests for !=.

impl Clone for Bech32

fn clone(&self) -> Bech32

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Ord for Bech32

fn cmp(&self, other: &Bech32) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl Debug for Bech32

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

Formats the value using the given formatter.

impl Display for Bech32

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

Formats the value using the given formatter.

impl Hash for Bech32

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where     H: Hasher,

Feeds a slice of this type into the given [Hasher].

impl FromStr for Bech32

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Bech32, Error>

Decode from a string