Struct Workspace 

pub struct Workspace { /* private fields */ }

A discovered repository with its resolved configuration and environment snapshot: the entry point of the stateless worktree API.

Implementations

impl Workspace

pub fn discover(dir: &Path, env: &Env, git: &dyn GitCli) -> Result<Workspace>

Discovers the repository containing dir, resolves the primary worktree root, and loads the merged configuration. Returns Error::NotInRepo when dir is not inside a Git repository.

pub fn lock(&self) -> Result<RepoLock>

Acquires the repository’s advisory mutation lock (issue #99). See RepoLock for the holding rules.

Fails with Error::SchemaTooNew when the repository is stamped with a metadata schema this build cannot interpret, re-read under the lock (issue #106) — so the version an embedder validated at discovery is still the version it holds the lock over.

pub fn root(&self) -> &Path

The primary worktree root (or the repository path when bare). This is the repo_root expected by the wtconfig write functions.

pub fn config(&self) -> &Config

The merged configuration (defaults, global config.toml, repo .wt.toml).

pub fn is_bare(&self) -> bool

Whether the primary repository is bare.

pub fn enumerate(&self, git: &dyn GitCli) -> Result<Vec<Worktree>>

Enumerates worktrees with their synchronous fields only (path, branch, slug, current/main/missing/detached markers).

pub fn list(&self, git: &dyn GitCli) -> Result<Vec<Worktree>>

Enumerates worktrees fully enriched: dirty/untracked status, ahead/behind, merge state, tip commits, and the cached PR metadata from wt.* config.

pub fn read_meta(&self, branch: &str) -> Result<WtMeta>

Reads the wt.* metadata recorded for branch.

pub fn write_meta( &self, git: &dyn GitCli, branch: &str, update: &MetaUpdate, ) -> Result<()>

Writes the Some fields of update to branch’s wt.* metadata, leaving every other recorded key alone (issue #95).

The whole update is applied under the advisory repository lock (issue #99), so a concurrent writer never observes half a bundle — do not call this while already holding a RepoLock. To make a read-check-write sequence atomic, take Workspace::lock and drive the wtconfig setters directly instead.

The schema gate is the lock’s (issue #106): nothing here runs ahead of it, so there is no separate check to keep in step.

pub fn clear_meta(&self, git: &dyn GitCli, branch: &str) -> Result<()>

Removes every wt.<branch>.* key, under the advisory repository lock. A branch with no recorded metadata is not an error.

pub fn create( &self, git: &dyn GitCli, hooks: &dyn HookRunner, options: &CreateOptions, ) -> Result<CreatedWorktree>

Creates (or reuses) a linked worktree per options: resolves the target from the configured path template, creates the branch off its base when needed, records wt.* metadata, runs the copy step, the post_create hook, and (when requested) submodule initialization. Partial failures before the hook are rolled back (spec §13).

pub fn remove( &self, git: &dyn GitCli, hooks: &dyn HookRunner, worktree: &Worktree, options: &RemoveOptions, ) -> Result<RemovedWorktree>

Removes worktree under options, enforcing the dirty/unpushed safety guards (returning Error::RemoveGuarded when they block), running the pre_remove hook, pruning a missing worktree, and deleting a fully-merged wt-created branch per the configuration.