Struct Interrupt 

pub struct Interrupt {
    pub id: String,
    pub reason: String,
    pub message: Option<String>,
    pub tool_call_id: Option<ToolCallId>,
    pub response_schema: Option<JsonObject>,
    pub expires_at: Option<String>,
    pub metadata: Option<JsonObject>,
    pub subagent_run_id: Option<SubagentRunId>,
}

A request for human input that pauses the run.

Fields

id: String

Correlation id — echoed back as ResumeEntry::interrupt_id when the run resumes.

reason: String

Machine-readable reason, for example "tool_approval".

message: Option<String>

Human-readable prompt to show the user.

tool_call_id: Option<ToolCallId>

The tool call awaiting approval, when the interrupt is about one.

response_schema: Option<JsonObject>

JSON Schema the resume payload must satisfy — lets a client render a form for the answer.

expires_at: Option<String>

When the interrupt stops being answerable, as an ISO-8601 timestamp.

metadata: Option<JsonObject>

Integration-specific extras.

subagent_run_id: Option<SubagentRunId>

The subagent whose work raised this interrupt, when it was raised inside one — absent for a root-raised interrupt. Attribution lives on each interrupt rather than on RUN_FINISHED because one run can carry interrupts from several subagents; a client uses it to render the approval request inside that subagent’s group. A JSON null is rejected — see crate::event::subagent.

Implementations

impl Interrupt

pub fn new(id: impl Into<String>, reason: impl Into<String>) -> Self

Builds an interrupt from its two required fields.

pub fn with_subagent_run_id( self, subagent_run_id: impl Into<SubagentRunId>, ) -> Self

Attributes the interrupt to the subagent that raised it.

Trait Implementations

impl Clone for Interrupt

fn clone(&self) -> Interrupt

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for Interrupt

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for Interrupt

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

Formats the value using the given formatter.

impl Default for Interrupt

fn default() -> Interrupt

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Interrupt

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl InterruptExt for Interrupt

fn resolve(&self, payload: impl Into<Value>) -> ResumeEntry

Answers this interrupt with a payload.

fn cancel(&self) -> ResumeEntry

Declines this interrupt.

fn is_tool_approval(&self) -> bool

Whether the interrupt is asking to approve a specific tool call.

impl JsonSchema for Interrupt

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 Interrupt

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

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 Interrupt

impl ToSchema for Interrupt

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

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference [utoipa::openapi::schema::Schema]s for this type.