Struct Store 

pub struct Store { /* private fields */ }

A store directory: the workspaces and profiles of one installation.

Implementations

impl Store

pub fn new(root: impl Into<PathBuf>) -> Self

The store at root. Nothing is read or written until it is asked for.

pub fn root(&self) -> &Path

The store directory itself.

pub fn profiles_dir(&self) -> PathBuf

The folder the profile definitions live in.

pub fn workspaces_dir(&self) -> PathBuf

The folder the workspaces live in.

pub fn prepare(&self) -> Result<(), Diagnostic>

Creates the folders the store needs, and proves they can be written.

Safe to call at every start: a store that is already there is left alone.

Errors

A diagnostic naming the directory and the reason, when it cannot be created or written.

pub fn adopt(&self) -> Vec<Diagnostic>

Gives every name this store carries from an older QCode the name it has today: Projects/ becomes Workspaces/, and inside each workspace project.qcode becomes workspace.qcode, Project/ and then Code/ become Work/, and Backup/Project.git becomes Backup/Code.git.

Each move is a single rename, so an interruption leaves the old name whole rather than two halves, and nothing is renamed onto something that is there already: a store holding both names is left as it is and said. Safe to call at every start — a store with none of the old names only looks.

pub fn workspace_paths(&self, id: &WorkspaceId) -> WorkspacePaths

Where everything of the workspace id is, whether or not it exists yet.

pub fn paths_of(&self, file: &WorkspaceFile) -> WorkspacePaths

Where everything of the workspace file describes is: Store::workspace_paths, with the person’s own folder as the code folder when the workspace works in one where it stands.

Everything that opens a workspace reads its folders from here, so the file tree, the shell, every container’s work folder and the backup all see the same folder.

pub fn create_workspace( &self, name: &str, created: Date, ) -> Result<WorkspaceFile, NewWorkspaceError>

Makes a workspace the user called name and gives it the tree of the design.

Errors

NewWorkspaceError::Name when the name yields no identifier, NewWorkspaceError::Taken when a folder of that identifier is already there — including one that only differs in case, which a file system that ignores case would treat as the same folder — and NewWorkspaceError::Blocked when the store cannot be written.

pub fn create_workspace_in( &self, name: &str, created: Date, folder: Option<PathBuf>, ) -> Result<WorkspaceFile, NewWorkspaceError>

Makes a workspace the user called name that works in folder where it stands, or in a Work/ of its own when folder is None.

The person’s folder is only named in the workspace file: nothing is made, moved or written in it.

Errors

As Store::create_workspace.

pub fn write_workspace(&self, file: &WorkspaceFile) -> Result<(), Diagnostic>

Writes a workspace’s workspace.qcode atomically and makes sure its folders — including one per profile it names — are there.

Errors

A diagnostic naming the directory or file that could not be written.

pub fn read_workspace(&self, id: &WorkspaceId) -> Loaded<Option<WorkspaceFile>>

Reads one workspace’s workspace.qcode.

pub fn workspaces(&self) -> Loaded<Vec<WorkspaceEntry>>

Every workspace folder of the store, sorted by folder name.

A folder that is broken or half-made is listed with its problems rather than left out: the user cannot repair what the list refuses to show. A store that cannot be read at all yields an empty list and one diagnostic.

pub fn profiles(&self) -> Loaded<Vec<Profile>>

Every profile definition of the store, sorted by file name.

A Profiles/ folder that is not there yet is not a problem: it means no profiles. A file that cannot be read or cannot be understood is reported and the rest are still returned, so one broken definition never hides the profiles that work.

Custom profiles live in Store::custom_profiles_dir, which is read as well: their parts are their own, and a QCode older than that folder does not see them at all.

pub fn custom_profiles_dir(&self) -> PathBuf

The folder a custom profile’s definition file is in.

pub fn profile_file(&self, profile: &Profile) -> PathBuf

The folder profile’s definition file is in, and its name: a ready-made template’s is the one every profile’s file has always been in, and a custom one’s is the folder of its own, which a QCode that does not know it never reads.

pub fn write_profile(&self, profile: &Profile) -> Result<(), Diagnostic>

Writes a profile’s definition file atomically, making the store’s folders first, and takes away the file of the kind it is not: a profile has one definition, whichever folder holds it, and two of them would list it twice.

Errors

A diagnostic naming the folder or file that could not be written.

Trait Implementations

impl Clone for Store

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 Store

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

Formats the value using the given formatter.

impl Eq for Store

impl PartialEq for Store

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Store