Struct InterruptInfo 

pub struct InterruptInfo {
    pub id: Option<String>,
    pub reason: Option<String>,
    pub payload: Option<Value>,
}

Information about a run interrupt.

When a run finishes with outcome == Interrupt, this struct contains information about why the interrupt occurred and what input is needed.

Example

use ag_ui_core::InterruptInfo;

let info = InterruptInfo::new()
    .with_id("approval-001")
    .with_reason("human_approval")
    .with_payload(serde_json::json!({
        "action": "DELETE",
        "table": "users",
        "affectedRows": 42
    }));

Fields

id: Option<String>

Optional identifier for tracking this interrupt across resume.

reason: Option<String>

Optional reason describing why the interrupt occurred. Common values: “human_approval”, “upload_required”, “policy_hold”

payload: Option<Value>

Optional payload with context for the interrupt UI. Contains arbitrary JSON data for rendering approval forms, proposals, etc.

Implementations

impl InterruptInfo

pub fn new() -> InterruptInfo

Creates a new empty InterruptInfo.

pub fn with_id(self, id: impl Into<String>) -> InterruptInfo

Sets the interrupt ID.

pub fn with_reason(self, reason: impl Into<String>) -> InterruptInfo

Sets the interrupt reason.

pub fn with_payload(self, payload: Value) -> InterruptInfo

Sets the interrupt payload.

Trait Implementations

impl Clone for InterruptInfo

fn clone(&self) -> InterruptInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InterruptInfo

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

Formats the value using the given formatter.

impl Default for InterruptInfo

fn default() -> InterruptInfo

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for InterruptInfo

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for InterruptInfo

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

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 InterruptInfo