Skip to main content

EventType

Enum EventType 

Source
pub enum EventType {
Show 36 variants TextMessageStart, TextMessageContent, TextMessageEnd, TextMessageChunk, ToolCallStart, ToolCallArgs, ToolCallEnd, ToolCallChunk, ToolCallResult, ThinkingStart, ThinkingEnd, ThinkingTextMessageStart, ThinkingTextMessageContent, ThinkingTextMessageEnd, StateSnapshot, StateDelta, MessagesSnapshot, ActivitySnapshot, ActivityDelta, Raw, Custom, RunStarted, RunFinished, RunError, StepStarted, StepFinished, ReasoningStart, ReasoningMessageStart, ReasoningMessageContent, ReasoningMessageEnd, ReasoningMessageChunk, ReasoningEnd, ReasoningEncryptedValue, SubagentStarted, SubagentFinished, SubagentError,
}
Expand description

The type discriminator of an Event, on its own.

Useful for routing and filtering without matching the payload. Exhaustive for the same reason Event is, and EventType::ALL is the list, in upstream order.

Variants§

§

TextMessageStart

Opens a text message. See TextMessageStartEvent.

§

TextMessageContent

Appends to a text message. See TextMessageContentEvent.

§

TextMessageEnd

Closes a text message. See TextMessageEndEvent.

§

TextMessageChunk

A whole text update in one event. See TextMessageChunkEvent.

§

ToolCallStart

Opens a tool call. See ToolCallStartEvent.

§

ToolCallArgs

Appends tool-call arguments. See ToolCallArgsEvent.

§

ToolCallEnd

Closes a tool call. See ToolCallEndEvent.

§

ToolCallChunk

A whole tool call in one event. See ToolCallChunkEvent.

§

ToolCallResult

A tool call’s result. See ToolCallResultEvent.

§

ThinkingStart

Opens a thinking block. See ThinkingStartEvent.

§

ThinkingEnd

Closes a thinking block. See ThinkingEndEvent.

§

ThinkingTextMessageStart

Opens a thinking message. See ThinkingTextMessageStartEvent.

§

ThinkingTextMessageContent

Appends thinking text. See ThinkingTextMessageContentEvent.

§

ThinkingTextMessageEnd

Closes a thinking message. See ThinkingTextMessageEndEvent.

§

StateSnapshot

Replaces the shared state. See StateSnapshotEvent.

§

StateDelta

Patches the shared state. See StateDeltaEvent.

§

MessagesSnapshot

Replaces the message history. See MessagesSnapshotEvent.

§

ActivitySnapshot

Publishes an activity. See ActivitySnapshotEvent.

§

ActivityDelta

Patches an activity. See ActivityDeltaEvent.

§

Raw

Forwards a provider event. See RawEvent.

§

Custom

An application-defined event. See CustomEvent.

§

RunStarted

Starts a run. See RunStartedEvent.

§

RunFinished

Finishes or pauses a run. See RunFinishedEvent.

§

RunError

Fails a run. See RunErrorEvent.

§

StepStarted

Starts a step. See StepStartedEvent.

§

StepFinished

Finishes a step. See StepFinishedEvent.

§

ReasoningStart

Opens a reasoning block. See ReasoningStartEvent.

§

ReasoningMessageStart

Opens a reasoning message. See ReasoningMessageStartEvent.

§

ReasoningMessageContent

Appends reasoning text. See ReasoningMessageContentEvent.

§

ReasoningMessageEnd

Closes a reasoning message. See ReasoningMessageEndEvent.

§

ReasoningMessageChunk

A whole reasoning update in one event. See ReasoningMessageChunkEvent.

§

ReasoningEnd

Closes a reasoning block. See ReasoningEndEvent.

§

ReasoningEncryptedValue

Carries an encrypted reasoning blob. See ReasoningEncryptedValueEvent.

§

SubagentStarted

Announces a subagent invocation. See SubagentStartedEvent.

§

SubagentFinished

Closes a subagent invocation. See SubagentFinishedEvent.

§

SubagentError

Fails a subagent invocation. See SubagentErrorEvent.

Implementations§

Source§

impl EventType

Source

pub const ALL: &'static [EventType]

Every event type the protocol defines, in upstream order.

Source

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

The wire string for this type.

Source§

impl EventType

Source

pub const fn is_attributable(self) -> bool

Whether this event type carries the optional subagentRunId attribution — 24 of the 36 do.

The three SUBAGENT_* lifecycle events return false: they carry the field as their required subject, not as a tag. The run lifecycle, MESSAGES_SNAPSHOT (whose messages carry their own) and the deprecated THINKING_* family have no such field.

Trait Implementations§

Source§

impl Clone for EventType

Source§

fn clone(&self) -> EventType

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 ComposeSchema for EventType

Source§

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

Source§

impl Copy for EventType

Source§

impl Debug for EventType

Source§

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

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

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

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 Display for EventType

Source§

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

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

impl Eq for EventType

Source§

impl FromStr for EventType

Source§

type Err = Error

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<Self>

Parses a string s to return a value of this type. Read more
Source§

impl Hash for EventType

Source§

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

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
Source§

impl JsonSchema for EventType

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl Ord for EventType

Source§

fn cmp(&self, other: &EventType) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for EventType

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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.
Source§

impl PartialOrd for EventType

Source§

fn partial_cmp(&self, other: &EventType) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Serialize for EventType

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
Source§

impl StructuralPartialEq for EventType

Source§

impl ToSchema for EventType

Source§

fn name() -> Cow<'static, str>

Return name of the schema. Read more
Source§

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference [utoipa::openapi::schema::Schema]s for this type. 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
§

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
Source§

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

Source§

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

Source§

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

§

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.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

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
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.

§

impl<T> PartialSchema for T
where T: ComposeSchema + ?Sized,

§

fn schema() -> RefOr<Schema>

Return ref or schema of implementing type that can then be used to construct combined schemas.
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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
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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.
§

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