Skip to main content

InterruptInfo

Struct InterruptInfo 

Source
pub struct InterruptInfo {
    pub id: Option<String>,
    pub reason: Option<String>,
    pub payload: Option<JsonValue>,
}
Expand description

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<JsonValue>

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

Implementations§

Source§

impl InterruptInfo

Source

pub fn new() -> Self

Creates a new empty InterruptInfo.

Source

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

Sets the interrupt ID.

Source

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

Sets the interrupt reason.

Source

pub fn with_payload(self, payload: JsonValue) -> Self

Sets the interrupt payload.

Trait Implementations§

Source§

impl Clone for InterruptInfo

Source§

fn clone(&self) -> InterruptInfo

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for InterruptInfo

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for InterruptInfo

Source§

fn default() -> InterruptInfo

Returns the “default value” for a type. Read more
Source§

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for InterruptInfo

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for InterruptInfo

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for InterruptInfo

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,