Struct Sessions 

pub struct Sessions { /* private fields */ }

The session factory. Build it with Laser::sessions or Laser::sessions_with.

Implementations

impl Sessions

pub fn create(&self, label: impl Into<String>) -> SessionBuilder

A session named label. Its id derives from the stream, the namespace, and the label, so the same label reaches the same session.

pub fn start(&self) -> SessionBuilder

A fresh session with a new id.

pub fn open(&self, conversation: ConversationId) -> Session

The session over an existing conversation, as a lens: no IO, no lease, and no author until Session::as_agent names one.

pub fn config(&self) -> &SessionConfig

This factory’s layout.

pub async fn bootstrap( &self, partitions: u32, retention: TopicRetention, ) -> Result<SessionBootstrap, LaserError>

Create the agent topics with Laser::bootstrap, then, when the deployment serves sessions and SessionConfig::register_source is on, register the stream as a session source. A refused registration is logged and reported as registered: false, never an error, because an account without session administration rights relies on provisioning to register the stream.

pub async fn unregister(&self) -> Result<(), LaserError>

Stop the deployment from indexing this stream’s sessions. The request goes through the authenticated managed control path and needs session administration rights on the stream. The index for the stream is dropped once the control record folds. A later bootstrap registers the stream again.

pub fn stream(&self) -> Result<&str, LaserError>

The stream the sessions ride.

impl Sessions

pub async fn get(&self, id: ConversationId) -> Result<SessionInfo, LaserError>

One session’s summary from the deployment’s session index.

pub fn list(&self) -> SessionListRequest

A page of this stream’s sessions, newest first. Chain the filters and finish with fetch.

pub fn events(&self, id: ConversationId) -> SessionEventsRequest

A page of one session’s events in broker time order. Chain the paging and finish with fetch.

pub async fn state( &self, id: ConversationId, history_limit: u32, ) -> Result<SessionStateView, LaserError>

One session’s folded state document with up to history_limit history rows. Zero leaves the history size to the server.

pub async fn links( &self, id: ConversationId, surface: Option<LinkSurface>, ) -> Result<SessionLinksView, LaserError>

The resources one session wrote, recalled, or touched, narrowed to surface when given.

pub async fn sources( &self, id: ConversationId, ) -> Result<SessionSources, LaserError>

The source partitions that hold one session’s records.

pub async fn changes( &self, after: u64, limit: u32, ) -> Result<SessionChanges, LaserError>

The change rows of this stream after after, up to limit. Zero leaves the page size to the server.

pub async fn watch( &self, poll_every: Duration, ) -> Result<SessionWatch, LaserError>

Follow this stream’s session changes from now, polling every poll_every and coalescing the changed session ids of each poll. The watch starts at the change rows retained when this call returns, so a change made after it is never missed.

impl Sessions

pub fn submit( &self, agent: impl Into<AgentId>, input: impl Into<Vec<u8>>, ) -> SubmitBuilder

Hand a new session to agent with input as its first command.

pub fn control(&self, stream: &str, id: ConversationId) -> SessionControl

Operator control of the session id in stream.

Trait Implementations

impl Clone for Sessions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.