Struct bech32::primitives::hrp::Hrp

source ·
pub struct Hrp { /* private fields */ }
Expand description

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

Implementations§

source§

impl Hrp

source

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.

source

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.

source

pub fn to_lowercase(&self) -> String

Available on crate feature alloc only.

Returns this human-readable part as a lowercase string.

source

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

Returns this human-readable part as bytes.

source

pub fn as_str(&self) -> &str

Returns this human-readable part as str.

source

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

source

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.

source

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

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

source

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

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

source

pub fn len(&self) -> usize

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

Guaranteed to be between 1 and 83 inclusive.

source

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”.

source

pub fn is_valid_on_mainnet(&self) -> bool

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

source

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”.

source

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”.

source

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§

source§

impl Clone for Hrp

source§

fn clone(&self) -> Hrp

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Hrp

source§

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

Formats the value using the given formatter. Read more
source§

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.

source§

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

Formats the value using the given formatter. Read more
source§

impl Hash for Hrp

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl Ord for Hrp

Case insensitive comparison.

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for Hrp

Case insensitive comparison.

source§

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

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

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.
source§

impl PartialOrd for Hrp

Case insensitive comparison.

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl Copy for Hrp

source§

impl Eq for Hrp

Auto Trait Implementations§

§

impl RefUnwindSafe for Hrp

§

impl Send for Hrp

§

impl Sync for Hrp

§

impl Unpin for Hrp

§

impl UnwindSafe for Hrp

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.