Struct EventsReadResult 

pub struct EventsReadResult {
    pub cursor: String,
    pub cursor_status: EventsCursorStatus,
    pub events: Vec<SessionEvent>,
    pub has_more: bool,
}

Batch of session events returned by a read, with cursor and continuation metadata.

Experimental. This type is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases.

Fields

cursor: String

Opaque cursor for the next read. Pass back unchanged in the next read.cursor to continue from where this read left off. Always present, even when no events were returned. For a backward read this cursor pages toward OLDER events; keep passing direction: backward with it (the cursor is also self-describing, so backward paging continues correctly).

cursor_status: EventsCursorStatus

Cursor status: ‘ok’ means the cursor was applied successfully. For session.eventLog.read, ‘expired’ means the cursor referred to an event that no longer exists in active history and the read fell back to a boundary of the remaining history: the beginning for a forward read or the newest window for a backward read. That fallback may overlap already rendered events, so active-session consumers should reset, rebase, or deduplicate before continuing. sessions.readPersistedEvents has stricter snapshot semantics: ‘expired’ returns an empty terminal page and never switches to a replacement journal generation. Other persisted-read I/O failures are RPC errors with diagnostics, not cursor expiry.

events: Vec<SessionEvent>

Session events for this batch, merged into a single stream in creation order: durable (persisted) events and ephemeral events interleave exactly as they were emitted. Set includeEphemeral: false to receive only durable events. Ephemeral events are never replayable once pruned from the in-memory ring, so a consumer that needs them should keep reading with a non-zero waitMs. For a backward (tail-first) read, the returned window contains persisted events only, still in chronological (oldest-to-newest) append order.

has_more: bool

True when more events are available in the read’s direction. For a backward read, true means older persisted events remain before the returned window. A persisted-event page may contain fewer than max events because of its byte budget while still reporting hasMore true; continue according to this flag rather than the event count.

Trait Implementations

impl Clone for EventsReadResult

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EventsReadResult

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

Formats the value using the given formatter.

impl Default for EventsReadResult

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EventsReadResult

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for EventsReadResult

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

where __S: Serializer,

Serialize this value into the given Serde serializer.