Struct Progress 

pub struct Progress {
    pub id: String,
    pub current: u64,
    pub total: Option<u64>,
    pub description: Option<String>,
    pub status: ProgressStatus,
    pub updated_at: u64,
    pub metadata: HashMap<String, Value>,
}

Progress information for long-running operations

Fields

id: String

Unique identifier for this progress

current: u64

Current progress value

total: Option<u64>

Total expected value (if known)

description: Option<String>

Human-readable description

status: ProgressStatus

Current status

updated_at: u64

Timestamp of last update (Unix timestamp)

metadata: HashMap<String, Value>

Additional metadata

Implementations

impl Progress

pub fn new(id: impl Into<String>) -> Progress

Create a new progress instance

pub fn with_total(self, total: u64) -> Progress

Set the total expected value

pub fn with_description(self, description: impl Into<String>) -> Progress

Set the description

pub fn with_current(self, current: u64) -> Progress

Set the current progress

pub fn with_status(self, status: ProgressStatus) -> Progress

Set the status

pub fn with_metadata(self, key: impl Into<String>, value: Value) -> Progress

Add metadata

pub fn update(&mut self, current: u64)

Update the current progress

pub fn update_with_description( &mut self, current: u64, description: impl Into<String>, )

Update with description

pub fn complete(&mut self)

Mark as completed

pub fn fail(&mut self, error: Option<String>)

Mark as failed

pub fn cancel(&mut self)

Mark as cancelled

pub fn percentage(&self) -> Option<f64>

Get progress percentage (0-100) if total is known

pub fn is_finished(&self) -> bool

Check if the operation is finished

pub fn is_active(&self) -> bool

Check if the operation is active

pub fn age(&self) -> Duration

Get the age of this progress update

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<(), Error>

Formats the value using the given formatter.

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<Progress, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Progress> for ProgressNotification

fn from(progress: Progress) -> ProgressNotification

Converts to this type from the input type.

impl Serialize for Progress

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

where __S: Serializer,

Serialize this value into the given Serde serializer.