Struct ToolCallCancelledState 

pub struct ToolCallCancelledState {
    pub tool_call_id: String,
    pub tool_name: String,
    pub display_name: String,
    pub intention: Option<String>,
    pub contributor: Option<ToolCallContributor>,
    pub meta: Option<JsonObject>,
    pub invocation_message: StringOrMarkdown,
    pub tool_input: Option<String>,
    pub reason: ToolCallCancellationReason,
    pub reason_message: Option<StringOrMarkdown>,
    pub user_suggestion: Option<Message>,
    pub selected_option: Option<ConfirmationOption>,
}

Tool call was cancelled before execution.

Fields

tool_call_id: String

Unique tool call identifier

tool_name: String

Internal tool name (for debugging/logging)

display_name: String

Human-readable tool name

intention: Option<String>

Human-readable description of what the tool invocation intends to do

contributor: Option<ToolCallContributor>

Reference to the contributor of the tool being called.

meta: Option<JsonObject>

Additional provider-specific metadata for this tool call.

This MAY include a ui field corresponding to the MCP Apps (SEP-1865) McpUiToolMeta found in MCP tool calls, which may be used in combination with the {@link contributor} to serve MCP Apps.

invocation_message: StringOrMarkdown

Message describing what the tool will do

tool_input: Option<String>

Raw tool input

reason: ToolCallCancellationReason

Why the tool was cancelled

reason_message: Option<StringOrMarkdown>

Optional message explaining the cancellation

user_suggestion: Option<Message>

What the user suggested doing instead

selected_option: Option<ConfirmationOption>

The confirmation option the user selected, if confirmation options were provided

Trait Implementations

impl Clone for ToolCallCancelledState

fn clone(&self) -> ToolCallCancelledState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolCallCancelledState

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolCallCancelledState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ToolCallCancelledState

fn eq(&self, other: &ToolCallCancelledState) -> 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 ToolCallCancelledState

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 ToolCallCancelledState