Enum Bech32Error 

#[non_exhaustive]
pub enum Bech32Error {
    InvalidHrp,
    OperationFailed,
    UnexpectedHrp,
    #[non_exhaustive]
    InvalidLength {
        expected: usize,
        got: usize,
    },
}

Errors from Bech32 (BIP-173) and Bech32m (BIP-350) decoding. Variant shapes are identical in debug and release builds; no secret material (payload bytes, HRP strings) is ever carried in an error. Errors produced when decoding Bech32 (BIP-173) or Bech32m (BIP-350) strings.

Requires feature encoding-bech32.

Variant shapes are identical in debug and release builds. No input-derived strings (such as the received HRP) are ever captured — the caller already holds the input and the expected HRP.

The std::error::Error impl requires the std feature. Without it the type still exists and still implements Display, but it is not an Error, so ? into Box<dyn Error> and std::io::Error::other will not compile. This is an MSRV consequence, not a policy: core::error::Error needs Rust 1.81 and this line targets 1.70. On 0.9.x the impl is unconditional and available in no_std.

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.

InvalidHrp

The Human-Readable Part (HRP) is invalid.

OperationFailed

General bech32 operation failure (malformed string or checksum mismatch).

This is where bit-conversion failures surface too: all bit conversion happens inside CheckedHrpstring::new(), and the .byte_iter() that follows a successful new() is infallible.

UnexpectedHrp

The decoded HRP does not match the HRP the caller required.

The received HRP is deliberately not captured — it is input-derived text. The caller passed the expected HRP and holds the input string.

#[non_exhaustive]

InvalidLength

The decoded payload length does not match the target type’s length.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

expected: usize

Number of bytes the target type requires.

got: usize

Number of bytes actually decoded.

Trait Implementations

impl Clone for Bech32Error

fn clone(&self) -> Bech32Error

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Bech32Error

impl Debug for Bech32Error

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

Formats the value using the given formatter.

impl Display for Bech32Error

Available on crate feature encoding-bech32 only.

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

Formats the value using the given formatter.

impl Eq for Bech32Error

impl Error for Bech32Error

Available on crate features encoding-bech32 and std only.

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 Bech32Error

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Bech32Error