Skip to main content

InspectReport

Struct InspectReport 

Source
#[non_exhaustive]
pub struct InspectReport { pub hrp: String, pub threshold: u8, pub tag: Tag, pub share_index: char, pub prefix_byte: u8, pub payload_bytes: Zeroizing<Vec<u8>>, pub checksum_valid: bool, pub kind: InspectKind, pub language: Option<u8>, }
Expand description

Structural dump of a parsed ms1 string. #[non_exhaustive] per SPEC §10 — v0.2+ may add fields (share-index detail, threshold-layer hints, derivation metadata).

Debug is hand-rolled (not derived) to redact payload_bytes (RULE Z-DEBUG, cycle-15 Lane M): Zeroizing<Vec<u8>>’s own derived Debug is non-redacting (forwards to Vec), so a derived Debug here would leak the raw entropy bytes. The hand-roll surfaces every structural field verbatim and renders the secret bytes as a length-only [REDACTED; N] placeholder. See the impl fmt::Debug below.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§hrp: String

Expected “ms” in v0.1.

§threshold: u8

Expected 0 in v0.1.

§tag: Tag

The parsed type tag (id field).

§share_index: char

Expected ‘s’ in v0.1.

§prefix_byte: u8

0x00 in v0.1 (reserved); becomes type discriminator in v0.2+.

§payload_bytes: Zeroizing<Vec<u8>>

Payload bytes after the prefix byte. Wrapped in Zeroizing so the decoded secret entropy is scrubbed on drop (cycle-15 Lane M). The hand-rolled Debug (below) redacts it; Deref<Target=Vec<u8>> keeps read-only consumers (.len(), hex::encode(&field)) unchanged.

§checksum_valid: bool

BCH verification result. True if the upstream codex32 parser accepted.

§kind: InspectKind

Payload kind derived from the prefix byte.

§language: Option<u8>

For kind == Mnem: the language byte (index into MNEM_LANGUAGE_NAMES). None for all other kinds.

Trait Implementations§

Source§

impl Clone for InspectReport

Source§

fn clone(&self) -> InspectReport

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for InspectReport

Source§

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

Hand-rolled redacting Debug (RULE Z-DEBUG): surfaces every structural field verbatim and renders the secret payload_bytes as a length-only [REDACTED; N] placeholder so the raw entropy can never reach a debug dump. Mirrors the no-echo precedent on crate::error::Error (error.rs).

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.