Enum Payload 

#[non_exhaustive]
pub enum Payload {
    Entr(Vec<u8>),
    Mnem {
        language: u8,
        entropy: Vec<u8>,
    },
}

v0.1 payload.

Caller-wrap contract (SPEC v0.9.0 §1 item 2): the Vec<u8> inside Payload::Entr is NOT zeroize-wrapped — widening the public type to Zeroizing<Vec<u8>> is a breaking change deferred indefinitely per SPEC §3 OOS-2. Callers MUST wrap the byte buffer at the use site (e.g., let bytes = Zeroizing::new((*p.as_bytes()).to_vec());) so that the secret-material lifetime ends with a scrubbed drop. ms-codec internally minimizes the un-scrubbed lifetime: encode + decode path locals are Zeroizing<Vec<u8>>; only the public Payload::Entr boundary is unwrapped.

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.

Entr(Vec<u8>)

BIP-39 entropy. Length MUST be in {16, 20, 24, 28, 32} bytes (bijective with BIP-39 word counts {12, 15, 18, 21, 24}).

Caller responsibility: ms-codec does NOT check the statistical quality of these bytes. Callers are responsible for sourcing entropy from a vetted CSPRNG, or from a BIP-39 mnemonic the user already trusts. FIPS-style entropy-quality checks would slow encoding and provide false assurance — they cannot detect attacker-supplied “pseudo-random” seeds crafted to pass standard randomness tests. See SPEC §3.6.

Caller-wrap reminder: wrap this Vec<u8> in Zeroizing at the use site so it scrubs on drop. ms-codec cannot wrap this for you without a breaking public-API change.

Mnem

BIP-39 mnemonic entropy with wordlist language tag. On-wire payload: [0x02][language_byte][entropy:N] where language_byte indexes into consts::MNEM_LANGUAGE_NAMES (0 = English, 1 = Japanese, …, 9 = Portuguese). Entropy length MUST be in {16, 20, 24, 28, 32} bytes.

Caller-wrap reminder: wrap entropy in Zeroizing at the use site.

Fields

language: u8

BIP-39 wordlist language index (0..=9).

entropy: Vec<u8>

BIP-39 entropy bytes (16/20/24/28/32 B).

Implementations

impl Payload

pub fn validate(&self) -> Result<()>

Validate the payload’s intrinsic structure (byte length for Entr/Mnem; language code range for Mnem). Encoder MUST call this before emitting; decoder calls it after extracting the payload bytes following the prefix byte.

pub fn kind(&self) -> PayloadKind

The PayloadKind discriminant.

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

Borrow the inner entropy byte slice. For Payload::Mnem, returns the entropy bytes only (without prefix or language byte).

Trait Implementations

impl Clone for Payload

fn clone(&self) -> Payload

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Payload

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

Formats the value using the given formatter.

impl Eq for Payload

impl PartialEq for Payload

fn eq(&self, other: &Payload) -> 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 StructuralPartialEq for Payload