Struct SessionDir 

pub struct SessionDir(/* private fields */);

A session’s directory. The agent keeps the session there through its store, which a plugin may replace (by default in the folders logs, blobs and files), so only the plain files beside the store are named here: the markers of a session an agent started in (Self::started), logged to (Self::is_saved) and being deleted (Self::is_deleting), the text log, the lock of the launcher running it, its working directory, its name and the session to switch to.

Implementations

impl SessionDir

pub fn at(path: impl Into<PathBuf>) -> Self

The session kept in the directory path, such as one a command names, rather than one of a Home’s.

pub fn path(&self) -> &Path

The directory itself.

pub fn id(&self) -> Option<SessionId>

The session’s id: the directory’s name, when it is one.

pub fn is_saved(&self) -> bool

Whether an agent of the session wrote its log, so it can be resumed: the session has the marker Self::mark_saved writes and is not being deleted.

pub fn is_deleting(&self) -> bool

Whether the session is being deleted: it has the marker Self::mark_deleting writes. Listings leave it out, and the agent’s next start finishes deleting it.

pub fn mark_deleting(&self) -> Result<()>

Marks the session as being deleted, before anything of it is removed, so a delete a crash cuts short is finished later and never leaves a half-removed session to resume.

Errors

When the marker cannot be written.

pub fn mark_saved(&self) -> Result<()>

Marks the session saved, as the agent’s store does when it first writes an agent’s log there.

Errors

When the marker cannot be written.

pub fn started(&self) -> PathBuf

The plain, empty marker of a session an agent started in: its first app ran a whole frame.

pub fn log(&self) -> PathBuf

The agent’s text log, unless a plugin keeps it elsewhere or not at all.

pub fn launcher_lock(&self) -> PathBuf

Held by the launcher running the session while it lives.

pub fn hold(&self) -> Result<Option<File>>

Takes Self::launcher_lock, creating the directory, unless another launcher holds it: the lock that marks the session as run, held until the returned file is dropped or the process dies. A launcher holds it while it runs the session, and a program that changes a saved session holds it while it does, so no launcher starts the session meanwhile. None when another holds it.

Errors

When the directory or the lock file cannot be made, or locking fails otherwise.

pub fn runs_elsewhere(&self) -> bool

Whether a launcher runs the session: one holds Self::launcher_lock. A command that rewrites or removes a saved session leaves such a one alone.

pub fn directory(&self) -> PathBuf

The working directory the session runs in, as plain text: written when the session starts, and where the launcher starts the agent when it resumes the session from elsewhere.

pub fn name(&self) -> Option<String>

The name the user gave the session, kept as plain text in the file name beside Self::directory, so the launcher finds the session by it (Home::find) without opening its store. Like the directory, it is readable on disk when the store seals what it keeps.

pub fn set_name(&self, name: Option<&str>) -> Result<()>

Names the session, or removes its name with None or a blank name. The name is written beside the file and renamed over it, so a reader sees the old name or the new one, never a part.

Errors

When the file cannot be written or removed.

pub fn switch(&self) -> PathBuf

Written by the agent before it exits with RELOAD_EXIT_CODE to run another session: the SessionId to resume, or nothing for a new session. The launcher reads and removes it.

pub fn working_directory(&self) -> Option<PathBuf>

The session’s working directory, when Self::directory names one that still exists.

Trait Implementations

impl Clone for SessionDir

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 SessionDir

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

Formats the value using the given formatter.