Struct RecoveryReport 

pub struct RecoveryReport { /* private fields */ }

Summary of a recovery scan over the seed-derived recovery mailbox.

skipped vs failed is the load-bearing distinction: a skipped VTXO was decided not to be spendable (spent, exited on-chain, or reported non-spendable), whereas a failed VTXO could not be decided due to an error. A non-empty failed or foreign set means funds may be missing, so it must not be taken for a complete recovery. Ids are kept (not counted) so a caller can log or retry the exact VTXOs.

Implementations

impl RecoveryReport

pub fn is_complete(&self) -> bool

Whether the scan accounted for every VTXO in the mailbox.

A failed VTXO or foreign id both mean funds may be missing, so neither may be present. failed is retryable; a foreign id instead needs a wider gap limit to be matched.

pub fn recovered(&self) -> &RecoveryReportEntry

pub fn push_recovered(&mut self, vtxo: &Vtxo<Full>)

pub fn skipped(&self) -> &RecoveryReportEntry

pub fn push_skipped(&mut self, vtxo: &Vtxo<Full>)

pub fn foreign(&self) -> &RecoveryReportEntry

pub fn push_foreign(&mut self, vtxo: &Vtxo<Full>)

pub fn failed(&self) -> &RecoveryReportEntry

pub fn push_failed(&mut self, id: VtxoId, amount: Option<Amount>)

pub fn exited(&self) -> &RecoveryReportEntry

pub fn push_exited(&mut self, vtxo: &Vtxo<Full>)

Trait Implementations

impl Clone for RecoveryReport

fn clone(&self) -> RecoveryReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RecoveryReport

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

Formats the value using the given formatter.

impl Default for RecoveryReport

fn default() -> RecoveryReport

Returns the “default value” for a type.