Struct Progress 

pub struct Progress { /* private fields */ }

How far a running tool call has got.

progress is the amount of work done so far and total, when known, the amount there is; both may be fractional and neither has a unit. message is a human-readable line describing the current state.

Implementations

impl Progress

pub const fn new(progress: f64) -> Self

Progress with the given amount of work done, no total, and no message.

pub const fn with_total(self, total: f64) -> Self

Sets the total amount of work.

pub fn with_message(self, message: impl Into<String>) -> Self

Sets a human-readable description of the current state.

pub const fn progress(&self) -> f64

The amount of work done so far.

pub const fn total(&self) -> Option<f64>

The total amount of work, if known.

pub fn message(&self) -> Option<&str>

The human-readable description of the current state, if any.

Trait Implementations

impl Clone for Progress

fn clone(&self) -> Self

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 PartialEq for Progress

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Progress