Struct Workspace 

pub struct Workspace {
    pub root: PathBuf,
    pub config: WorkspaceConfig,
}

A Hexz workspace rooted at a directory with associated configuration.

Fields

root: PathBuf

Root directory of the workspace.

config: WorkspaceConfig

Workspace configuration loaded from config.json.

Implementations

impl Workspace

pub fn init(path: &Path, base_archive: Option<PathBuf>) -> Result<Self>

Initialize a new workspace at the given path with an optional base archive.

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

Persist the current workspace configuration to disk.

pub fn find(start_path: &Path) -> Result<Option<Self>>

Search upward from start_path to find an existing workspace.

pub fn overlay_path(&self) -> PathBuf

Return the path to the overlay directory for this workspace.

pub fn metadata_dir(&self) -> PathBuf

Return the path to the centralized metadata directory for this workspace.

Trait Implementations

impl Debug for Workspace

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

Formats the value using the given formatter.