Struct Registry 

pub struct Registry {
    pub containers: Vec<Registered>,
}

The containers QCode started, in the order it first started them.

Fields

containers: Vec<Registered>

Every container, each name once.

Implementations

impl Registry

pub fn file() -> Option<PathBuf>

Where the list of this user is kept: containers.toml in QCode’s data folder, or None on a machine that names no home, where nothing is recorded and so nothing is stopped.

pub fn is_empty(&self) -> bool

Whether the list holds nothing.

pub fn add(&mut self, name: &str, engine: EngineKind) -> bool

Adds name in engine, unless it is there already or is not one of QCode’s names. Answers whether the list changed.

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

Reads the list at path.

A file that is not there is an empty list: nothing was started yet, or everything was stopped. A file that cannot be read is an empty list with a diagnostic that says why.

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

Reads a list from text, reporting problems against file.

An entry that is not one of QCode’s containers, or names no engine QCode drives, is left out with a diagnostic; a name listed twice is kept once.

pub fn to_toml(&self) -> String

The file as it is written to disk.

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

Writes the list 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.

pub fn record( path: &Path, name: &str, engine: EngineKind, ) -> Result<Vec<Diagnostic>>

Notes in the list at path that QCode started the container name in engine, and answers what was wrong with the file it found there.

The file is only written when the name is new, so the tab opened for the hundredth time costs a read and nothing more, and a watcher of the file is not woken for nothing. A file that was damaged is written again with what could be read of it and the new name: the container that just started would otherwise never be stopped, and the problems are answered so the person hears of them. A name that is not QCode’s is not written at all.

This reads and writes the disk, so it belongs on a background thread.

Errors

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

pub fn replace(path: &Path, remaining: &Self) -> Result<()>

Writes remaining to the list at path in place of what it held, which is what stopping the containers does once it is through: only what could not be stopped stays listed.

Errors

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

Trait Implementations

impl Clone for Registry

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 Registry

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

Formats the value using the given formatter.

impl Default for Registry

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Registry

impl PartialEq for Registry

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Registry