Enum Error 

#[non_exhaustive]
pub enum Error {
    Codex32(Error),
    WrongHrp {
        got: String,
    },
    ThresholdNotZero {
        got: u8,
    },
    ShareIndexNotSecret {
        got: char,
    },
    TagInvalidAlphabet {
        got: [u8; 4],
    },
    UnknownTag {
        got: [u8; 4],
    },
    ReservedTagNotEmittedInV01 {
        got: [u8; 4],
    },
    ReservedPrefixViolation {
        got: u8,
    },
    UnexpectedStringLength {
        got: usize,
        allowed: &'static [usize],
    },
    PayloadLengthMismatch {
        tag: [u8; 4],
        expected: &'static [usize],
        got: usize,
    },
    TooManyErrors {
        bound: u8,
    },
}

ms-codec error type.

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.

Codex32(Error)

Upstream codex32 parse / checksum failure (delegated from rust-codex32).

WrongHrp

HRP was not “ms” (SPEC §4 rule 2).

Fields

got: String

The HRP that was observed.

ThresholdNotZero

Threshold was not 0 (SPEC §4 rule 3).

Fields

got: u8

The threshold-position byte (ASCII digit) that was observed.

ShareIndexNotSecret

Share-index was not ‘s’ — BIP-93 requires ‘s’ for threshold=0 (SPEC §4 rule 4).

Fields

got: char

The share-index character that was observed.

TagInvalidAlphabet

Tag bytes were not in the codex32 alphabet (SPEC §4 rule 5).

Fields

got: [u8; 4]

The 4-byte id-field bytes that failed alphabet validation.

UnknownTag

Tag was structurally valid but not in RESERVED_TAG_TABLE (SPEC §4 rule 6).

Fields

got: [u8; 4]

The 4-byte tag that was not recognized.

ReservedTagNotEmittedInV01

Tag was in RESERVED_TAG_TABLE but reserved-not-emitted in v0.1 (SPEC §4 rule 7, SPEC §3.5.1 encoder symmetry).

Fields

got: [u8; 4]

The 4-byte reserved tag (one of seed/xprv/mnem/prvk in v0.1).

ReservedPrefixViolation

Reserved-prefix byte was not 0x00 (SPEC §4 rule 8).

Fields

got: u8

The non-zero prefix byte that was observed.

UnexpectedStringLength

Total string length was outside the v0.1 emittable set (SPEC §4 rule 9).

Fields

got: usize

The total string length that was observed.

allowed: &'static [usize]

The set of v0.1-emittable lengths.

PayloadLengthMismatch

Payload byte length did not match the tag’s spec (SPEC §3.5, §4 rule 10).

Fields

tag: [u8; 4]

The 4-byte tag whose length set was checked against.

expected: &'static [usize]

The set of valid byte lengths for this tag.

got: usize

The observed payload byte length (after stripping the prefix byte).

TooManyErrors

BCH error-correction (bch_decode) reported the input is uncorrectable — the number of symbol errors exceeds the regular code’s t = 4 correction capacity (singleton bound d = 8). Surfaced by crate::decode_with_correction when bch_decode::decode_regular_errors returns None, or when a post-correction re-verification step fails (catches pathological 5+-error patterns that fool the decoder into producing a “consistent” but invalid locator). Added v0.2.0 per plan §1 D29 + §2.B.2.

bound = 8 is the BCH(93,80,8) singleton bound. ms1 is single-chunk only — no chunk_index field (cf. md-codec’s TooManyErrors which carries chunk-set context).

Fields

bound: u8

Singleton bound for the BCH regular code (always 8).

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 From<Error> for Error

fn from(e: Error) -> Self

Converts to this type from the input type.