Struct Session 

pub struct Session {
    pub active: Option<WorkspaceId>,
    pub workspaces: Vec<SessionWorkspace>,
}

The workspaces that were open, in the order the rail showed them.

Fields

active: Option<WorkspaceId>

The workspace the rail had open, when there was one.

workspaces: Vec<SessionWorkspace>

The workspaces, in rail order.

Implementations

impl Session

pub fn file() -> Option<PathBuf>

Where the session of this user is kept: session.toml in QCode’s data folder, or None on a machine that names no home, where the session is not kept at all.

pub fn is_empty(&self) -> bool

Whether the session has no workspace to go back to.

pub fn active_index(&self) -> usize

The position of the workspace that was open, which is the first one when the file names none or names one it does not list.

pub fn load(path: &Path) -> Loaded<Option<Self>>

Reads the session file at path.

A file that is not there is no session and no problem: nothing was saved yet. A file that cannot be read is no session either, with a diagnostic that says why.

pub fn parse(file: &str, text: &str) -> Loaded<Self>

Reads a session from text, reporting problems against file.

A workspace whose id is unusable and a tab that does not say what it opens are skipped with a diagnostic; everything else of the file is kept.

pub fn to_toml(&self) -> String

The file as it is written to disk.

pub fn save(&self, path: &Path) -> Result<()>

Writes the session to path atomically, making its folder first when it is not there.

Errors

Returns the I/O error when the folder or the file cannot be written.

Trait Implementations

impl Clone for Session

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 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.

impl Eq for Session

impl PartialEq for Session

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Session