Skip to main content

SessionEvent

Struct SessionEvent 

Source
pub struct SessionEvent {
    pub id: String,
    pub timestamp: String,
    pub parent_id: Option<String>,
    pub ephemeral: Option<bool>,
    pub agent_id: Option<String>,
    pub debug_cli_received_at_ms: Option<i64>,
    pub debug_ws_forwarded_at_ms: Option<i64>,
    pub event_type: String,
    pub data: Value,
}
Expand description

A single event in a session’s timeline.

Events form a linked chain via parent_id. The event_type string identifies the kind (e.g. "assistant.message_delta", "session.idle", "tool.execution_start"). Event-specific payload is in data as untyped JSON.

Fields§

§id: String

Unique event ID (UUID v4).

§timestamp: String

ISO 8601 timestamp.

§parent_id: Option<String>

ID of the preceding event in the chain.

§ephemeral: Option<bool>

Transient events that are not persisted to disk.

§agent_id: Option<String>

Sub-agent instance identifier. Absent for events emitted by the root/main agent and for session-level events.

§debug_cli_received_at_ms: Option<i64>

Debug timestamp: when the CLI received this event (ms since epoch).

§debug_ws_forwarded_at_ms: Option<i64>

Debug timestamp: when the event was forwarded over WebSocket.

§event_type: String

Event type string (e.g. "assistant.message", "session.idle").

§data: Value

Event-specific data. Structure depends on event_type.

Implementations§

Source§

impl SessionEvent

Source

pub fn parsed_type(&self) -> SessionEventType

Parse the string event_type into a typed SessionEventType enum.

Returns SessionEventType::Unknown for unrecognized event types, ensuring forward compatibility with newer CLI versions.

Source

pub fn typed_data<T: DeserializeOwned>(&self) -> Option<T>

Deserialize the event data field into a typed struct.

Returns None if deserialization fails (e.g. unknown event type or schema mismatch). Prefer typed data accessors for specific event types where you need strongly-typed field access.

Source

pub fn is_transient_error(&self) -> bool

model_call errors are transient — the CLI agent loop continues after them and may succeed on the next turn. These should not be treated as session-ending errors.

Trait Implementations§

Source§

impl Clone for SessionEvent

Source§

fn clone(&self) -> SessionEvent

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 SessionEvent

Source§

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

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

impl<'de> Deserialize<'de> for SessionEvent

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 SessionEvent

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§

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