Struct bech32::Hrp

pub struct Hrp { /* private fields */ }

The human-readable part (human readable prefix before the ‘1’ separator).

Implementations

impl Hrp

pub fn parse(hrp: &str) -> Result<Self, Error>

Parses the human-readable part checking it is valid as defined by BIP-173.

This does not check that the hrp is an in-use HRP within Bitcoin (eg, “bc”), rather it checks that the HRP string is valid as per the specification in BIP-173:

The human-readable part, which is intended to convey the type of data, or anything else that is relevant to the reader. This part MUST contain 1 to 83 US-ASCII characters, with each character having a value in the range [33-126]. HRP validity may be further restricted by specific applications.

pub const fn parse_unchecked(hrp: &str) -> Self

Parses the human-readable part (see Hrp::parse for full docs).

Does not check that hrp is valid according to BIP-173 but does check for valid ASCII values, replacing any invalid characters with X.

pub fn to_lowercase(&self) -> String

Available on crate feature alloc only.

Returns this human-readable part as a lowercase string.

pub fn as_bytes(&self) -> &[u8]

Returns this human-readable part as bytes.

pub fn as_str(&self) -> &str

Returns this human-readable part as str.

pub fn byte_iter(&self) -> ByteIter<'_>

Creates a byte iterator over the ASCII byte values (ASCII characters) of this HRP.

If an uppercase HRP was parsed during object construction then this iterator will yield uppercase ASCII chars. For lowercase bytes see Self::lowercase_byte_iter

pub fn char_iter(&self) -> CharIter<'_>

Creates a character iterator over the ASCII characters of this HRP.

If an uppercase HRP was parsed during object construction then this iterator will yield uppercase ASCII chars. For lowercase bytes see Self::lowercase_char_iter.

pub fn lowercase_byte_iter(&self) -> LowercaseByteIter<'_>

Creates a lowercase iterator over the byte values (ASCII characters) of this HRP.

pub fn lowercase_char_iter(&self) -> LowercaseCharIter<'_>

Creates a lowercase character iterator over the ASCII characters of this HRP.

pub fn len(&self) -> usize

Returns the length (number of characters) of the human-readable part.

Guaranteed to be between 1 and 83 inclusive.

pub fn is_valid_segwit(&self) -> bool

Returns true if this HRP is valid according to the bips.

BIP-173 states that the HRP must be either “bc” or “tb”.

pub fn is_valid_on_mainnet(&self) -> bool

Returns true if this HRP is valid on the Bitcoin network i.e., HRP is “bc”.

pub fn is_valid_on_testnet(&self) -> bool

Returns true if this HRP is valid on the Bitcoin testnet network i.e., HRP is “tb”.

pub fn is_valid_on_signet(&self) -> bool

Returns true if this HRP is valid on the Bitcoin signet network i.e., HRP is “tb”.

pub fn is_valid_on_regtest(&self) -> bool

Returns true if this HRP is valid on the Bitcoin regtest network i.e., HRP is “bcrt”.

Trait Implementations

impl Clone for Hrp

fn clone(&self) -> Hrp

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Hrp

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

Formats the value using the given formatter.

impl Display for Hrp

Displays the human-readable part.

If an uppercase HRP was parsed during object construction then the returned string will be in uppercase also. For a lowercase string see Self::to_lowercase.

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

Formats the value using the given formatter.

impl Hash for Hrp

fn hash<H: Hasher>(&self, h: &mut H)

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Hrp

Case insensitive comparison.

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Hrp

Case insensitive comparison.

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Hrp

Case insensitive comparison.

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

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

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

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

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

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

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

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

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

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

impl Copy for Hrp

impl Eq for Hrp