Struct Workdir 

pub struct Workdir {
    base: PathBuf,
    canonical: PathBuf,
}

An agent’s working directory, resolved once.

Fields

base: PathBuf

canonical: PathBuf

Implementations

impl Workdir

pub fn open(base: &Path) -> Result<Workdir>

The workdir at base, which must already exist (callers create it).

pub fn base(&self) -> &Path

The workdir’s own path, as given to Workdir::open.

pub fn resolve(&self, rel: &str) -> Result<PathBuf>

rel inside the workdir, or a refusal: lexically outside it, under a folder that links out of it, or a symlink itself (dangling or not).

fn ensure_parent(&self, path: &Path) -> Result<()>

The parent folder of a resolved path, created inside the workdir.

pub fn write(&self, rel: &str, bytes: &[u8], owner_only: bool) -> Result<()>

Replace rel with bytes, atomically. Parent folders are created inside the workdir. owner_only makes the file 0600 on Unix (for files holding keys, such as .mcp.json); otherwise a file being replaced keeps its mode, as an in-place write would.

pub fn create_new(&self, rel: &str, bytes: &[u8]) -> Result<bool>

Create rel with bytes only if nothing is there: Ok(true) when created, Ok(false) when it already existed. The file appears whole or not at all, even across a crash: it is written and synced under a temporary name, then hard-linked into place, which fails if rel already exists (Codex on #4141 — a partial .pre-adopt backup would otherwise block adoption forever).

pub fn append(&self, rel: &str, bytes: &[u8]) -> Result<()>

Append bytes to an existing rel: a true append, never a rewrite, so an edit racing the caller’s earlier read is kept.

pub fn remove_file(&self, rel: &str) -> Result<()>

Remove rel. The path is checked like a write, so a link to outside the workdir is refused rather than removed.

pub fn remove_dir(&self, rel: &str) -> Result<()>

Remove the empty folder rel.

pub fn open_lock_file(&self, rel: &str) -> Result<File>

Open rel for read/write, creating it if absent and never truncating it: for lock files.

Trait Implementations

impl Clone for Workdir

fn clone(&self) -> Workdir

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Workdir

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

Formats the value using the given formatter.