Enum AddressError 

#[non_exhaustive]
pub enum AddressError {
    NotLowercase,
    InvalidBech32m {
        reason: String,
    },
    HrpMismatch {
        found: String,
        expected: &'static str,
    },
    PayloadLength {
        len: usize,
        expected: usize,
    },
    VersionMismatch {
        found: u8,
        expected: u8,
    },
    NonCanonical,
}

Why an address string was rejected by Address::from_str.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

NotLowercase

The string contains ASCII uppercase.

BIP-173 permits an all-uppercase spelling and the bech32 crate accepts it; the protocol admits the lowercase form only.

InvalidBech32m

The string is not structurally valid bech32m: bad charset, missing or misplaced separator, mixed case, or a checksum that is absent, corrupt, or computed with the original bech32 constant instead of bech32m.

Fields

reason: String

Rendering of the underlying bech32 decode error.

HrpMismatch

Valid bech32m, but the human-readable part is not Address::HRP_STR.

Fields

found: String

Human-readable part found in the input.

expected: &'static str

The required human-readable part.

PayloadLength

The decoded payload is not Address::PAYLOAD_LEN bytes.

Fields

len: usize

Decoded payload length.

expected: usize

Required payload length.

VersionMismatch

The payload does not start with a supported version byte.

Fields

found: u8

Version byte found in the payload.

expected: u8

The only version byte this build understands.

NonCanonical

The string decodes to a well-formed payload but is not that payload’s canonical spelling — non-zero padding bits, or a data part padded out with extra characters that truncate to the same bytes.

Accepting these would give one identity several valid addresses, so they are rejected rather than normalized.

Trait Implementations

impl Clone for AddressError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AddressError

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

Formats the value using the given formatter.

impl Display for AddressError

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

Formats the value using the given formatter.

impl Eq for AddressError

impl Error for AddressError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for AddressError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for AddressError