Struct ToolProgressState 

pub struct ToolProgressState {
    pub progress: f64,
    pub total: Option<f64>,
    pub message: Option<String>,
}

Canonical activity state shape for tool progress updates.

Fields

progress: f64

Normalized progress value.

total: Option<f64>

Optional absolute total if the source has one.

message: Option<String>

Optional human-readable progress message.

Trait Implementations

impl Clone for ToolProgressState

fn clone(&self) -> ToolProgressState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolProgressState

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

Formats the value using the given formatter.

impl Default for ToolProgressState

fn default() -> ToolProgressState

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ToolProgressState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ToolProgressState

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl State for ToolProgressState

const PATH: &'static str = ""

Canonical JSON path for this state type.

type Ref<'a> = ToolProgressStateRef<'a>

The reference type that provides typed access.

fn state_ref<'a>( doc: &'a DocCell, base: Path, sink: PatchSink<'a>, ) -> Self::Ref<'a>

Create a state reference at the specified path.

fn from_value(value: &Value) -> TireaResult<Self>

Deserialize this type from a JSON value.

fn to_value(&self) -> TireaResult<Value>

Serialize this type to a JSON value.

fn diff_ops(old: &Self, new: &Self, base_path: &Path) -> TireaResult<Vec<Op>>

Compare two instances and emit minimal ops for changed fields.

fn register_lattice(_registry: &mut LatticeRegistry)

Register lattice fields into the given registry.

fn lattice_keys() -> &'static [&'static str]

Return the JSON keys of fields annotated with #[tirea(lattice)].

fn to_patch(&self) -> Result<Patch, TireaError>

Create a patch that sets this value at the root.