Struct Session 

pub struct Session { /* private fields */ }

A stateful agent session.

Implementations

impl Session

pub fn new() -> Self

Creates an empty session with the interactive limits.

pub fn with_options(options: SessionOptions) -> Self

Creates an empty session with explicit options.

pub fn options(&self) -> &SessionOptions

Options the session runs under.

pub fn active_name(&self) -> Option<&str>

Name of the active document.

pub fn structure(&self, name: Option<&str>) -> Result<&Structure, Error>

The structure of one document, or of the active one.

Errors

Returns Error::UnknownDocument or Error::NoDocument.

pub fn active(&self) -> Option<&Document>

The active document, when there is one.

pub fn contains(&self, name: &str) -> bool

Whether a document is open.

pub fn len(&self) -> usize

Number of open documents.

pub fn is_empty(&self) -> bool

Whether no document is open.

pub fn summaries(&self) -> Vec<DocumentSummary>

Summaries of the open documents, in name order.

pub fn documents_answer(&self) -> Answer

The documents answer.

pub fn run(&mut self, verb: &str, arguments: &Value) -> Result<Answer, Error>

Runs one verb.

Errors

Returns Error::UnknownVerb for a name outside the catalogue, the argument errors of the verb and the errors of the operation it runs.

Trait Implementations

impl Debug for Session

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

Formats the value using the given formatter.

impl Default for Session

fn default() -> Self

Returns the “default value” for a type.