Struct EventData 

pub struct EventData {
    pub input: Option<Value>,
    pub error: Option<String>,
    pub output: Option<Value>,
    pub chunk: Option<Value>,
}

Data associated with a streaming event.

This struct contains optional fields that may be present depending on the event type (start, stream, end).

Fields

input: Option<Value>

The input passed to the Runnable that generated the event.

Inputs will sometimes be available at the START of the Runnable, and sometimes at the END of the Runnable.

If a Runnable is able to stream its inputs, then its input by definition won’t be known until the END of the Runnable when it has finished streaming its inputs.

error: Option<String>

The error that occurred during the execution of the Runnable.

This field is only available if the Runnable raised an exception.

output: Option<Value>

The output of the Runnable that generated the event.

Outputs will only be available at the END of the Runnable.

For most Runnable objects, this field can be inferred from the chunk field, though there might be some exceptions for special a cased Runnable (e.g., like chat models), which may return more information.

chunk: Option<Value>

A streaming chunk from the output that generated the event.

Chunks support addition in general, and adding them up should result in the output of the Runnable that generated the event.

Implementations

impl EventData

pub fn new() -> Self

Create a new empty EventData.

pub fn with_input(self, input: Value) -> Self

Create EventData with an input value.

pub fn with_error(self, error: impl Into<String>) -> Self

Create EventData with an error.

pub fn with_output(self, output: Value) -> Self

Create EventData with an output value.

pub fn with_chunk(self, chunk: Value) -> Self

Create EventData with a chunk value.

Trait Implementations

impl Clone for EventData

fn clone(&self) -> EventData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EventData

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

Formats the value using the given formatter.

impl Default for EventData

fn default() -> EventData

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EventData

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for EventData

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

where __S: Serializer,

Serialize this value into the given Serde serializer.