Struct WorkspaceFile 

pub struct WorkspaceFile {
    pub id: WorkspaceId,
    pub name: String,
    pub created: Option<Date>,
    pub folder: Option<PathBuf>,
    pub profiles: Vec<WorkspaceProfile>,
    pub backup_skip: Vec<String>,
    pub backup_assets: bool,
}

The contents of a workspace’s workspace.qcode.

Fields

id: WorkspaceId

The workspace’s identifier, which is also the name of its folder.

name: String

The name the user gave it, in the user’s own writing.

created: Option<Date>

The day the workspace was made, when the file records a readable one.

folder: Option<PathBuf>

The person’s own folder the workspace works in where it stands, when it was made that way: an absolute path on this machine, mounted as the containers’ work folder in place of the workspace’s own Work/. None is a workspace with a Work/ of its own, which every file written before the choice existed is.

profiles: Vec<WorkspaceProfile>

The profiles the workspace carries, in the order the file lists them.

backup_skip: Vec<String>

The folders and files inside Work/ its backup leaves out, each a path inside the workspace written with /, in the order the file lists them.

backup_assets: bool

Whether its backup takes Assets/ too. Off unless the file says so: assets are often large and kept elsewhere as well.

Implementations

impl WorkspaceFile

pub fn new(id: WorkspaceId, name: impl Into<String>, created: Date) -> Self

A workspace made today with no profiles yet.

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

Reads a workspace.qcode, reporting problems against file.

The value is None only when the file names no workspace this program could open: the identifier is missing or is not one. Anything else — a missing name, an unreadable date, a profile without a name, a key nobody knows — is a diagnostic beside a usable workspace.

pub fn to_toml(&self) -> String

The file as it is written to disk.

Trait Implementations

impl Clone for WorkspaceFile

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 WorkspaceFile

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

Formats the value using the given formatter.

impl Eq for WorkspaceFile

impl PartialEq for WorkspaceFile

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for WorkspaceFile