Struct ShortHrp

pub struct ShortHrp(/* private fields */);

Short human-readable address part

Implementations

impl ShortHrp

pub const MAX_HRP_LENGTH: usize = 5usize

Maximum length of the human-readable part of the address

pub const MAINNET: Self

Mainnet human-readable part

pub const TESTNET: Self

Testnet human-readable part

pub fn new(hrp: Hrp) -> Option<Self>

Create a new instance.

Returns None if length of human-readable part is longer than Self::MAX_HRP_LENGTH.

Methods from Deref<Target = Hrp>

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 ShortHrp

fn clone(&self) -> ShortHrp

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ShortHrp

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

Formats the value using the given formatter.

impl Deref for ShortHrp

type Target = Hrp

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl PartialEq for ShortHrp

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for ShortHrp

impl Eq for ShortHrp

impl StructuralPartialEq for ShortHrp