Skip to main content

StructuredEvent

Enum StructuredEvent 

Source
pub enum StructuredEvent {
    Thought {
        text: String,
    },
    Content {
        text: String,
        author: String,
    },
    ToolCall {
        name: String,
        args: Value,
        call_id: Option<String>,
    },
    ToolResult {
        name: String,
        result: Value,
    },
    Error {
        message: String,
    },
    Activity {
        description: String,
    },
    ToolConfirmation {
        hint: Option<String>,
        confirmed: bool,
    },
    Finished,
}
Expand description

A typed, structured representation of an agent event.

Variants§

§

Thought

Internal reasoning or chain-of-thought text.

Fields

§text: String

The reasoning text.

§

Content

User-facing content with author attribution.

Fields

§text: String

The content text.

§author: String

Who authored this content (e.g., “model”, “agent”).

§

ToolCall

A tool/function call from the model.

Fields

§name: String

Tool name.

§args: Value

Tool arguments as JSON.

§call_id: Option<String>

Optional unique call identifier.

§

ToolResult

The result of a tool/function call.

Fields

§name: String

Tool name.

§result: Value

The result value.

§

Error

An error event.

Fields

§message: String

Error description.

§

Activity

An activity/status update (e.g., agent transfer, escalation).

Fields

§description: String

Human-readable description of the activity.

§

ToolConfirmation

A tool confirmation request or response.

Fields

§hint: Option<String>

Optional hint for the confirmation UI.

§confirmed: bool

Whether the tool call was confirmed.

§

Finished

The agent has finished processing.

Implementations§

Source§

impl StructuredEvent

Source

pub fn event_type(&self) -> EventType

Returns the classification of this event.

Trait Implementations§

Source§

impl Clone for StructuredEvent

Source§

fn clone(&self) -> StructuredEvent

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 StructuredEvent

Source§

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

Formats the value using the given formatter. Read more

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> 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> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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