Enum RunEvent 

pub enum RunEvent {
    Started {
        run_id: i64,
        total_steps: u64,
    },
    Step {
        run_id: i64,
        index: u64,
        step_type: String,
        status: String,
    },
    Progress {
        run_id: i64,
        completed: u64,
        total: u64,
    },
    Finished {
        run_id: i64,
        status: String,
    },
    Error {
        run_id: i64,
        message: String,
    },
    Unknown(Value),
}

One frame of the GET /v1/runs/:id/events SSE stream (engine/events.rs::RunEvent, tagged on "event", snake_case).

Finished and Error are stream-closing. Unrecognized frames (a future daemon vocabulary) decode as RunEvent::Unknown instead of failing.

Variants

Started

The run is registered and about to drive its steps.

Fields

run_id: i64

total_steps: u64

Step

A step transitioned; status ∈ running|succeeded|failed|skipped (open set).

Fields

run_id: i64

index: u64

step_type: String

status: String

Progress

Coarse progress hint.

Fields

run_id: i64

completed: u64

total: u64

Finished

Terminal: final status (success | failed | cancelled | timeout | captcha_required | twofa_required, open set). Stream-closing.

Fields

run_id: i64

status: String

Error

Terminal: the run failed around the step loop. Stream-closing.

Fields

run_id: i64

message: String

Unknown(Value)

A frame this SDK version does not recognize (raw payload preserved).

Implementations

impl RunEvent

pub fn parse(data: &str) -> RunEvent

Parse one SSE data: payload. Never fails: unparseable/unknown frames become RunEvent::Unknown (with the raw text wrapped as a JSON string when the payload is not even JSON).

pub fn run_id(&self) -> Option<i64>

The run id this event belongs to, when carried.

pub fn is_terminal(&self) -> bool

True for the two stream-closing variants (Finished / Error).

Trait Implementations

impl Clone for RunEvent

fn clone(&self) -> RunEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RunEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RunEvent

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RunEvent

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RunEvent