Enum ToolCallStatus 

#[non_exhaustive]
pub enum ToolCallStatus {
    Pending,
    InProgress,
    Paused,
    Completed,
    Failed,
    Cancelled,
    Other(String),
}

Available on crate feature unstable_protocol_v2 only.

Execution status of a tool call.

Tool calls progress through different statuses during their lifecycle.

See protocol docs: Status

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Pending

The tool call hasn’t started running yet, for example because its input is streaming, it is awaiting approval, or it is scheduled to run later.

InProgress

The tool call is currently running.

Paused

The tool call has started, is not running now, and will not continue until something resumes it. It may return to in_progress any number of times.

Completed

The tool call completed successfully.

Failed

The tool call failed with an error.

Cancelled

The tool call was cancelled before it completed.

Other(String)

Custom or future tool call status.

Values beginning with _ are reserved for implementation-specific extensions. Unknown values that do not begin with _ are reserved for future ACP variants.

Clients treat a tool call with an unrecognized status as still in progress.

Trait Implementations

impl Clone for ToolCallStatus

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 ToolCallStatus

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

Formats the value using the given formatter.

impl Default for ToolCallStatus

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ToolCallStatus

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ToolCallStatus

impl JsonSchema for ToolCallStatus

Available on crate feature schemars only.

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for ToolCallStatus

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ToolCallStatus

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 ToolCallStatus