Struct Session 

pub struct Session {
    pub agents: Vec<SavedAgent>,
    pub saved: BTreeMap<String, Value>,
    pub repairs: Vec<Repair>,
}

A session as its logs left it.

Fields

agents: Vec<SavedAgent>

Its agents, in the order their logs were started.

saved: BTreeMap<String, Value>

The session’s own saved values by key: the SESSION log’s.

repairs: Vec<Repair>

What reading it repaired or worked around.

Implementations

impl Session

pub fn value<T>(&self, key: &str) -> Option<Result<T, Error>>

where T: DeserializeOwned,

The session’s own saved value under key (the SESSION log’s), read as a T: None when it has none, an error when the value is not a T.

pub fn main_agent(&self) -> Option<&SavedAgent>

The main agent: the first by main_order of the agents a restore brings back (not retired, nor spawned by one retired).

impl Session

pub fn read(store: &(dyn Store + 'static)) -> Result<Session, SessionError>

Reads the session kept in store, without writing to it: a torn last line is reported and left. Retired agents are read too.

Errors

When the store fails, or any log is in another format or holds a record that cannot be read or does not apply: the whole session is refused.

pub fn read_lenient( store: &(dyn Store + 'static), ) -> Result<(Session, Vec<Unreadable>), SessionError>

Reads each log of the session kept in store that reads, as Self::read does, and sets aside each that does not, with why: for a reader that shows what it can, such as an export or a search. A restore reads strictly, so it never goes on from part of a session.

Errors

When the store cannot list its logs.

pub fn agent(&self, id: &str) -> Option<&SavedAgent>

The agent id.

pub fn agent_mut(&mut self, id: &str) -> Option<&mut SavedAgent>

The agent id, to change it.

pub fn save( &mut self, store: &(dyn Store + 'static), ) -> Result<(), SessionError>

Saves the session to store, the one it was read from (or an empty one): appends each agent’s unsaved changes (an agent new to the store gets a header), its changed and removed saved values, and its retirement, and the session’s changed values. Each agent’s conversation is left with nothing unsaved. A torn last line of a log written to is first set aside, as Writer::open does.

Errors

SessionError::Changed when a log that holds changes moved on since the agent’s conversation was read, or holds another conversation, before anything is written; when the store fails, a log is in another format, or a line has no stamp; or when a write fails. It reads the stamps of the logs’ changes, not the changes, so a change that does not apply is refused by Self::read, not here.

Trait Implementations

impl Clone for Session

fn clone(&self) -> Session

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Session

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

Formats the value using the given formatter.

impl Default for Session

fn default() -> Session

Returns the “default value” for a type.

impl PartialEq for Session

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Session