Struct SessionEventLogReadResult 

pub struct SessionEventLogReadResult {
    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; ‘expired’ means the cursor referred to an event that no longer exists in history (e.g. truncated or compacted away) and the read fell back to a boundary of the remaining history. For a forward read the fallback starts from the beginning of the remaining history; for a backward read it falls back to the tail (the newest window). Because the fallback page is a fresh boundary snapshot rather than a continuation of the requested cursor, it may overlap events the consumer has already rendered — a backward fallback to the tail in particular can repeat the newest window. On ‘expired’, consumers should reset or rebase their local pagination state (or deduplicate by event id) before continuing from the returned cursor rather than blindly appending/prepending the fallback page.

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 forward read, true means the batch returned max events and more are available immediately. For a backward read, true means older persisted events remain before the returned window.

Trait Implementations

impl Clone for SessionEventLogReadResult

fn clone(&self) -> SessionEventLogReadResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionEventLogReadResult

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

Formats the value using the given formatter.

impl Default for SessionEventLogReadResult

fn default() -> SessionEventLogReadResult

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SessionEventLogReadResult

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SessionEventLogReadResult

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

where __S: Serializer,

Serialize this value into the given Serde serializer.