Struct Progress 

pub struct Progress {
    pub stage: Stage,
    pub from: String,
    pub to: Option<String>,
    pub parked_run: Option<String>,
    pub started_at: Timestamp,
    pub updated_at: Timestamp,
    pub detail: Option<String>,
}

One upgrade’s progress, persisted at progress_path.

Kept on disk rather than in memory because the process that finishes an upgrade is never the one that started it: the successor is a fresh binary (see web::spawn_successor), and the only thing the two share is the disk. Beside the run history rather than under the cache dir alongside [state_path]: this is not throttle bookkeeping, it is the record of one upgrade the operator asked for, and - like a parked run - it is meant to outlive the process that wrote it.

Fields

stage: Stage

Where this upgrade has gotten to.

from: String

Version this upgrade started from.

to: Option<String>

Version it is replacing itself with.

parked_run: Option<String>

The run Stage::Parking is waiting on, when one was in flight.

started_at: Timestamp

When this upgrade was asked for.

updated_at: Timestamp

Last time stage changed.

detail: Option<String>

Why Stage::Failed happened; None for every other stage.

Implementations

impl Progress

pub fn new(from: String, to: String) -> Self

A fresh record for an upgrade that is about to replace the binary.

pub fn advance(&mut self, stage: Stage)

Move to stage, stamping when it changed.

pub fn fail(&mut self, detail: impl Into<String>)

Stop at Stage::Failed, with a reason a human can read.

Trait Implementations

impl Clone for Progress

fn clone(&self) -> Progress

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Progress

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Progress

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Progress

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.