Skip to main content

EventType

syncable_ag_ui_client

Enum EventType

pub enum EventType {
Show 26 variants    TextMessageStart,
    TextMessageContent,
    TextMessageEnd,
    TextMessageChunk,
    ThinkingTextMessageStart,
    ThinkingTextMessageContent,
    ThinkingTextMessageEnd,
    ToolCallStart,
    ToolCallArgs,
    ToolCallEnd,
    ToolCallChunk,
    ToolCallResult,
    ThinkingStart,
    ThinkingEnd,
    StateSnapshot,
    StateDelta,
    MessagesSnapshot,
    ActivitySnapshot,
    ActivityDelta,
    Raw,
    Custom,
    RunStarted,
    RunFinished,
    RunError,
    StepStarted,
    StepFinished,
}

Expand description

Re-export core types for convenience Event types for the AG-UI protocol.

This enum enumerates all possible event types in the protocol. Event types are serialized using SCREAMING_SNAKE_CASE (e.g., TEXT_MESSAGE_START).

§Event Categories

Text Messages: TextMessageStart, TextMessageContent, TextMessageEnd, TextMessageChunk
Thinking Messages: ThinkingTextMessageStart, ThinkingTextMessageContent, ThinkingTextMessageEnd
Tool Calls: ToolCallStart, ToolCallArgs, ToolCallEnd, ToolCallChunk, ToolCallResult
Thinking Steps: ThinkingStart, ThinkingEnd
State: StateSnapshot, StateDelta
Messages: MessagesSnapshot
Run Lifecycle: RunStarted, RunFinished, RunError
Step Lifecycle: StepStarted, StepFinished
Other: Raw, Custom

Variants§

TextMessageStart

Start of a text message from the assistant.

TextMessageContent

Content chunk of a text message (streaming delta).

TextMessageEnd

End of a text message.

TextMessageChunk

Complete text message chunk (non-streaming alternative).

ThinkingTextMessageStart

Start of a thinking text message (extended thinking).

ThinkingTextMessageContent

Content chunk of a thinking text message.

ThinkingTextMessageEnd

End of a thinking text message.

ToolCallStart

Start of a tool call.

ToolCallArgs

Arguments chunk for a tool call (streaming).

ToolCallEnd

End of a tool call.

ToolCallChunk

Complete tool call chunk (non-streaming alternative).

ToolCallResult

Result of a tool call execution.

ThinkingStart

Start of a thinking step (chain-of-thought).

ThinkingEnd

End of a thinking step.

StateSnapshot

Complete state snapshot.

StateDelta

Incremental state update (JSON Patch RFC 6902).

MessagesSnapshot

Complete messages snapshot.

ActivitySnapshot

Complete activity snapshot.

ActivityDelta

Incremental activity update (JSON Patch RFC 6902).

Raw

Raw event from the underlying provider.

Custom

Custom application-specific event.

RunStarted

Agent run has started.

RunFinished

Agent run has finished successfully.

RunError

Agent run encountered an error.

StepStarted

A step within a run has started.

StepFinished

A step within a run has finished.

Implementations§

impl EventType

pub fn as_str(&self) -> &'static str

Returns the string representation of the event type.

Trait Implementations§

impl Clone for EventType

fn clone(&self) -> EventType

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

impl Debug for EventType

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for EventType

fn deserialize<D>( deserializer: D, ) -> Result<EventType, <D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl Display for EventType

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

Formats the value using the given formatter. Read more

impl Hash for EventType

fn hash<H>(&self, state: &mut H)
where __H: Hasher,

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

impl PartialEq for EventType

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for EventType

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

Serialize this value into the given Serde serializer. Read more

impl Copy for EventType

impl Eq for EventType

impl StructuralPartialEq for EventType

Auto Trait Implementations§

impl Freeze for EventType

impl RefUnwindSafe for EventType

impl Send for EventType

impl Sync for EventType

impl Unpin for EventType

impl UnsafeUnpin for EventType

impl UnwindSafe for EventType

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

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

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T> ToStringFallible for T
where T: Display,

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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