Struct Workspace 

pub struct Workspace { /* private fields */ }

A workspace roots every file/search/shell operation at a directory and enforces a small capability policy.

All paths supplied to the tools are resolved relative to root and rejected if they escape it. Mutating operations require is_writable; bash requires bash_allowed.

The workspace also carries a small amount of shared session state — the set of files that have been read — so that edit_file can require a prior read_file (guarding against blind overwrites).

Workspace is cheap to clone; clones share the read-tracking state.

Implementations

impl Workspace

pub fn new(root: impl Into<PathBuf>) -> Self

Create a read-write workspace rooted at root (bash enabled).

If root exists it is canonicalized so containment checks are robust.

pub fn read_only(root: impl Into<PathBuf>) -> Self

Create a read-only workspace (no writes, no bash) — useful for exploration / plan modes.

pub fn writable(self, yes: bool) -> Self

Set whether mutating file operations are permitted.

pub fn allow_bash(self, yes: bool) -> Self

Set whether the bash tool is permitted.

pub fn bash_timeout(self, timeout: Duration) -> Self

Set the default timeout applied to bash commands.

pub fn max_output_bytes(self, bytes: usize) -> Self

Set the maximum number of bytes captured from a stream before truncation.

pub fn inherit_env(self, yes: bool) -> Self

Pass the whole parent environment to bash.

Off by default, because the parent environment of an agent process routinely holds provider API keys and a model-directed command can read them with env. Enable it only when the commands you run genuinely need the caller’s environment and you accept that exposure.

pub fn env_allowlist<I, S>(self, keys: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Replace the variables bash receives when the environment is not inherited.

Defaults to DEFAULT_ENV_ALLOWLIST. Adding a variable that holds a credential re-exposes it.

pub fn inherits_env(&self) -> bool

Whether bash inherits the parent environment.

pub fn bash_env(&self) -> Vec<(String, String)>

The variables bash receives, resolved from the current process.

Empty when the environment is inherited, in which case the caller must not clear it.

pub fn root(&self) -> &Path

The workspace root.

pub fn is_writable(&self) -> bool

Whether mutating file operations are permitted.

pub fn bash_allowed(&self) -> bool

Whether the bash tool is permitted.

pub fn bash_timeout_value(&self) -> Duration

The default bash timeout.

pub fn max_output(&self) -> usize

The output-capture cap.

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

Resolve a user-supplied path against the root, rejecting any path that escapes it (lexically). The target need not exist yet.

pub fn display(&self, path: &Path) -> String

Render a path relative to the root for display (falls back to the full path).

Trait Implementations

impl Clone for Workspace

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.