Struct CancelToolCallRequest 

#[non_exhaustive]
pub struct CancelToolCallRequest {
    pub session_id: SessionId,
    pub tool_call_id: ToolCallId,
    pub meta: Option<Map<String, Value>>,
}

Available on crate feature unstable_protocol_v2 only.

Request parameters for cancelling one tool call.

Clients MUST NOT send it unless the tool call currently advertises capabilities.cancel.

The Agent responds once it has accepted the cancellation. The response does not mean the work has stopped. The Agent confirms it with a tool_call_update to a final status: normally cancelled, or completed or failed if the work finished first.

The Agent responds with -32602 if the tool call is unknown, already final, or not cancellable. Cancelling a tool call does not change the foreground state by itself.

See protocol docs: Cancelling Tool Calls

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.

session_id: SessionId

The ID of the session that owns the tool call.

tool_call_id: ToolCallId

The ID of the tool call to cancel.

meta: Option<Map<String, Value>>

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Omitted and null are equivalent and mean no metadata. Implementations MUST NOT assign meaning to keys they do not recognize.

See protocol docs: Extensibility

Implementations

impl CancelToolCallRequest

pub fn new( session_id: impl Into<SessionId>, tool_call_id: impl Into<ToolCallId>, ) -> CancelToolCallRequest

Builds CancelToolCallRequest with the required request fields set. Optional fields start unset or empty.

pub fn meta( self, meta: impl IntoOption<Map<String, Value>>, ) -> CancelToolCallRequest

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT assign meaning to keys they do not recognize.

See protocol docs: Extensibility

Trait Implementations

impl Clone for CancelToolCallRequest

fn clone(&self) -> CancelToolCallRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CancelToolCallRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CancelToolCallRequest

fn deserialize<__D>( __deserializer: __D, ) -> Result<CancelToolCallRequest, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CancelToolCallRequest

impl JsonRpcMessage for CancelToolCallRequest

fn matches_method(method: &str) -> bool

Check if this message type matches the given method name.

fn method(&self) -> &str

The method name for the message.

fn to_untyped_message(&self) -> Result<UntypedMessage, Error>

Convert this message into an untyped message.

fn parse_message(method: &str, params: &Value) -> Result<Self, Error>

Parse this type from a method name and the message’s JSON params.

impl JsonRpcRequest for CancelToolCallRequest

type Response = CancelToolCallResponse

The type of data expected in response.

impl JsonSchema for CancelToolCallRequest

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 CancelToolCallRequest

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CancelToolCallRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CancelToolCallRequest