Struct Workspace

pub struct Workspace { /* private fields */ }

Implementations

impl Workspace

pub fn new_temp() -> Workspace

Creates a workspace that’s temporary

pub fn new(path: impl AsRef<Path>) -> Workspace

pub fn path(&self) -> &Path

Gets the root directory of the workspace

pub fn resolve_path(&self, path: &Path) -> PathBuf

Resolves a path relative to this workspace.

‘/’ is treated as the workspace root.

Panic

• Will panic if .. present at root.
• Will also panic if prefix is present (only on windows)

pub fn is_protected(&self, path: &Path) -> bool

pub fn create_file(&self, path: &Path) -> Result<RegularFile, WorkspaceError>

pub fn as_dir(&self) -> Dir<'_>

pub fn join<P>(&self, path: P) -> PathBuf

where P: AsRef<Path>,

Trait Implementations

impl Clone for Workspace

fn clone(&self) -> Workspace

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Workspace

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

Formats the value using the given formatter.

impl WorkspaceDirectory for Workspace

fn my_workspace(&self) -> &Workspace

Gets the workspace this directory is part of.

fn rel_path(&self) -> PathBuf

Gets the path of this directory relative to the workspace.

fn file(&self, file: &str) -> Result<RegularFile, WorkspaceError>

Creates a file within this directory

fn dir(&self, name: &str) -> Result<Dir<'_>, WorkspaceError>

Creates a directory within this directory

fn protected_dir(&self, name: &str) -> Result<Dir<'_>, WorkspaceError>

Creates a protected directory in this directory

fn protected_file(&self, name: &str) -> Result<RegularFile, WorkspaceError>

Creates a protected file in this directory

fn new_workspace<P>(&self, path: P) -> Workspace

where P: AsRef<Path>,

Create a workspace that’s relative to this workspace. Shares proteced paths with parent workspace and other created workspaces.

fn absolute_path(&self) -> PathBuf

Gets the absolute path of this directory

fn is_protected(&self, path: &Path) -> bool

Checks if a path is protected.

impl WorkspaceEntry for Workspace

fn into_absolute_path(self) -> Result<PathBuf, WorkspaceError>