Skip to main content

Event

Enum Event 

Source
pub enum Event {
    OnStart {
        runnable: String,
        run_id: Uuid,
        input: Value,
    },
    OnNodeStart {
        node: String,
        step: u64,
        run_id: Uuid,
    },
    OnNodeEnd {
        node: String,
        step: u64,
        output: Value,
        run_id: Uuid,
    },
    OnLlmToken {
        token: String,
        run_id: Uuid,
    },
    OnToolStart {
        tool: String,
        args: Value,
        run_id: Uuid,
    },
    OnToolEnd {
        tool: String,
        result: Value,
        run_id: Uuid,
    },
    OnError {
        error: String,
        run_id: Uuid,
    },
    OnEnd {
        runnable: String,
        run_id: Uuid,
        output: Value,
    },
    OnCheckpoint {
        step: u64,
        run_id: Uuid,
    },
    Custom {
        kind: String,
        payload: Value,
        run_id: Uuid,
    },
}
Expand description

A structured event emitted by stream_events() — exposes per-step graph activity, tool calls, token deltas, and errors.

Variants§

§

OnStart

A Runnable started.

Fields

§runnable: String

Name of the runnable that started.

§run_id: Uuid

Correlation ID for this run.

§input: Value

Serialized input value.

§

OnNodeStart

A graph node started.

Fields

§node: String

Node name.

§step: u64

Superstep number.

§run_id: Uuid

Correlation ID for this run.

§

OnNodeEnd

A graph node finished.

Fields

§node: String

Node name.

§step: u64

Superstep number.

§output: Value

Serialized output value.

§run_id: Uuid

Correlation ID for this run.

§

OnLlmToken

LLM emitted a token.

Fields

§token: String

The token text.

§run_id: Uuid

Correlation ID for this run.

§

OnToolStart

Tool execution started.

Fields

§tool: String

Tool name.

§args: Value

Serialized arguments.

§run_id: Uuid

Correlation ID for this run.

§

OnToolEnd

Tool execution finished.

Fields

§tool: String

Tool name.

§result: Value

Serialized result.

§run_id: Uuid

Correlation ID for this run.

§

OnError

A Runnable errored.

Fields

§error: String

Error description.

§run_id: Uuid

Correlation ID for this run.

§

OnEnd

A Runnable finished successfully.

Fields

§runnable: String

Name of the runnable that finished.

§run_id: Uuid

Correlation ID for this run.

§output: Value

Serialized output value.

§

OnCheckpoint

A graph engine persisted a checkpoint at a superstep boundary.

Fields

§step: u64

Step number that was just persisted.

§run_id: Uuid

Correlation ID for this run.

§

Custom

User-emitted event from a graph node via NodeCtx::write_custom. Carries an arbitrary kind label and a JSON payload — the consumer decides how to interpret it. Used by StreamMode::Custom to surface node-authored progress signals without cluttering the typed enum.

Fields

§kind: String

Caller-defined label (e.g. "progress", "chunk").

§payload: Value

Arbitrary JSON payload.

§run_id: Uuid

Correlation ID for this run.

Trait Implementations§

Source§

impl Clone for Event

Source§

fn clone(&self) -> Event

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 Event

Source§

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

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

impl<'de> Deserialize<'de> for Event

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 Serialize for Event

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

Auto Trait Implementations§

§

impl Freeze for Event

§

impl RefUnwindSafe for Event

§

impl Send for Event

§

impl Sync for Event

§

impl Unpin for Event

§

impl UnsafeUnpin for Event

§

impl UnwindSafe for Event

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

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