Enum RecoveryStatus 

pub(crate) enum RecoveryStatus {
    InProgress(RecoveryProgress),
    Failed {
        last_progress: RecoveryProgress,
        error: String,
    },
}

The state of a single module’s recovery, as tracked by the client.

RecoveryProgress can only ever express how far a recovery got, never that it gave up, which makes a failed recovery indistinguishable from a merely slow one and blocks every waiter on the outcome forever. Carrying the failure as a state of the very thing the progress describes makes the contradictory “done and failed” unrepresentable for a module, so a recovery that terminally fails resolves the waiters it used to strand. Only a terminal failure does: a recovery that keeps retrying instead of giving up, as fetching the federation’s history does, resolves nothing, and its waiters keep waiting.

Only the APIs returning a result observe the failure. The ones exposing the progress itself, like Client::has_pending_recoveries and Client::subscribe_to_recovery_progress, keep reporting a failed recovery as not done, which it is.

Internal: the failure reaches callers as the error of the waiting API, not as this type, so it stays crate-private rather than committing an accessorless public type to the API surface.

The module this describes is the key of the map this is stored in, so it is deliberately not repeated here: a copy could contradict the key it is filed under.

Variants

InProgress(RecoveryProgress)

The latest progress of a recovery that has not failed.

A successfully completed recovery is represented by a done progress.

Failed

The recovery terminally failed at last_progress, which is kept so the progress-reporting APIs can keep describing the module.

Fields

last_progress: RecoveryProgress

error: String

Implementations

impl RecoveryStatus

pub(crate) fn is_successfully_done(&self) -> bool

Whether the module’s recovery completed successfully.

A failure is terminal but never done: the module recovered nothing beyond the progress it got to.

pub(crate) fn progress(&self) -> RecoveryProgress

The progress view of the status, which is all a progress-reporting API can express.

Trait Implementations

impl Clone for RecoveryStatus

fn clone(&self) -> RecoveryStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RecoveryStatus

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

Formats the value using the given formatter.