Struct ToolProgress 

#[non_exhaustive]
pub struct ToolProgress {
    pub run_id: String,
    pub tool_use_id: String,
    pub tool_name: String,
    pub phase: String,
    pub status: ToolProgressStatus,
    pub dispatch_elapsed_ms: u64,
    pub metadata: Value,
}

One phase transition emitted by a tool.

Sinks reconstruct per-phase wall-clock duration from successive transitions on the same (tool_use_id, phase). The SDK does not hold phase-state on behalf of the tool — the dispatch_elapsed_ms marker is a timeline reference, not a per-phase length.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

run_id: String

Per-run correlation id. Echoes crate::ExecutionContext::run_id so sinks can join phase telemetry against AgentEvent streams. Empty string when the dispatch did not originate inside an agent run.

tool_use_id: String

Stable tool-use id matching the originating model ToolUse block. Pairs with AgentEvent::ToolStart / ToolComplete / ToolError for the same dispatch.

tool_name: String

Tool name being dispatched.

phase: String

Phase identifier — schema_lookup, vector_search, validation, correction_retry, … The tool author picks the vocabulary; sinks treat it as an opaque key.

status: ToolProgressStatus

Status transition for the phase.

dispatch_elapsed_ms: u64

Wall-clock elapsed since the tool dispatch began. Acts as a timeline marker across every phase in the same dispatch — per-phase duration is the difference between successive transitions on the same (tool_use_id, phase) pair.

metadata: Value

Optional structured metadata for UIs and telemetry sinks. Value::Null when the tool author chose not to attach anything.

Trait Implementations

impl Clone for ToolProgress

fn clone(&self) -> ToolProgress

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolProgress

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolProgress

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ToolProgress

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ToolProgress

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ToolProgress