Skip to main content

StreamEvent

Enum StreamEvent 

Source
pub enum StreamEvent {
    Start {
        command: String,
        ts: String,
    },
    Step {
        name: String,
        status: StepStatus,
        duration_ms: Option<u64>,
        error: Option<String>,
        ts: String,
    },
    Progress {
        name: String,
        percent: Option<u8>,
        message: Option<String>,
        ts: String,
    },
    Log {
        level: LogLevel,
        message: String,
        ts: String,
    },
    Event {
        name: String,
        data: Value,
        ts: String,
    },
    Result {
        command: String,
        timestamp: u64,
        exit_code: i32,
        schema_version: Option<String>,
        result: Value,
        next_actions: Vec<NextAction>,
    },
    Error {
        command: String,
        timestamp: u64,
        exit_code: i32,
        schema_version: Option<String>,
        error: ErrorBody,
        fix: String,
        data: Option<Value>,
        next_actions: Vec<NextAction>,
    },
}
Expand description

Typed NDJSON stream event.

Terminal variants (Result, Error) use custom serialization to inject ok as a fixed boolean and always include timestamp (emitted as an RFC 3339 UTC string). The ok field cannot be set incorrectly — it is derived from the variant. The ts on non-terminal variants is caller-supplied; use RFC 3339 UTC (2026-06-10T14:42:17Z) to match the terminal events.

Variants§

§

Start

Fields

§command: String
§

Step

Fields

§name: String
§status: StepStatus
§duration_ms: Option<u64>
§

Progress

Fields

§name: String
§percent: Option<u8>
§message: Option<String>
§

Log

Fields

§level: LogLevel
§message: String
§

Event

Fields

§name: String
§data: Value
§

Result

Fields

§command: String
§timestamp: u64
§exit_code: i32
§schema_version: Option<String>
§result: Value
§next_actions: Vec<NextAction>
§

Error

Fields

§command: String
§timestamp: u64
§exit_code: i32
§schema_version: Option<String>
§data: Option<Value>

The failure’s structured payload, mirroring crate::ErrorEnvelope::data. The same failure must read the same on both terminal channels: an agent that switched to NDJSON cannot lose the facts the direct envelope would have handed it.

§next_actions: Vec<NextAction>

Implementations§

Trait Implementations§

Source§

impl Clone for StreamEvent

Source§

fn clone(&self) -> StreamEvent

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for StreamEvent

Source§

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

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

impl PartialEq for StreamEvent

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for StreamEvent

Source§

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

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

impl StructuralPartialEq for StreamEvent

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.