Expand description
Workspace capability abstractions.
Built-in tools expose stable model-facing contracts (read, write, ls,
bash, …). The concrete place where those operations happen is supplied
by a workspace capability backend. The default backend is the local
filesystem (see LocalWorkspaceBackend); hosts can provide remote,
browser, DFS, or container-backed implementations by assembling
WorkspaceServices through WorkspaceServicesBuilder.
Structs§
- Command
Output - Command execution output.
- Command
Request - Command execution request.
- Local
Workspace Backend - Local filesystem-backed workspace implementation.
- Remote
GitBackend - Client for a remote
gitserver. See module docs / RFC for the protocol. - Remote
GitBackend Config - Configuration for a
RemoteGitBackend. - Remote
GitConflict - Error returned for HTTP 409 / 422 responses that carry a recoverable
failure code. Tools downcast with
anyhow::Error::downcast_refto react — for example, retrying after aWORKING_TREE_DIRTYby stashing first. - Virtual
Path Resolver - Lexical resolver suitable for virtual/browser/DFS workspaces.
- Workspace
Capabilities - Workspace capability flags used to gate which built-in tools are registered.
- Workspace
DirEntry - Directory entry returned by a workspace backend.
- Workspace
GitBranch - Branch information returned by a workspace Git provider.
- Workspace
GitCheckout Output - Checkout output returned by a workspace Git provider.
- Workspace
GitCheckout Request - Checkout request for a workspace Git provider.
- Workspace
GitCommit - Commit information returned by a workspace Git provider.
- Workspace
GitCreate Branch Request - Branch creation request for a workspace Git provider.
- Workspace
GitCreate Worktree Request - Worktree creation request for a workspace Git provider.
- Workspace
GitDiff Request - Diff request for a workspace Git provider.
- Workspace
GitRemote - Remote information returned by a workspace Git provider.
- Workspace
GitRemove Worktree Request - Worktree removal request for a workspace Git provider.
- Workspace
GitStash - Stash information returned by a workspace Git provider.
- Workspace
GitStash Request - Stash request for a workspace Git provider.
- Workspace
GitStatus - Repository status returned by a workspace Git provider.
- Workspace
GitWorktree - Worktree information returned by a workspace Git provider.
- Workspace
GitWorktree Mutation - Mutation result for workspace Git worktree operations.
- Workspace
Glob Request - Glob request for workspace-backed search.
- Workspace
Glob Result - Glob result returned by a workspace search provider.
- Workspace
Grep Request - Grep request for workspace-backed search.
- Workspace
Grep Result - Grep result returned by a workspace search provider.
- Workspace
Path - A normalized virtual path inside a workspace.
- Workspace
Ref - Identity and display metadata for a workspace.
- Workspace
Services - The host-provided workspace capability bundle used by tool execution.
- Workspace
Services Builder - Builder for assembling workspace services without constructor arity churn.
- Workspace
Version Conflict - Error returned by
WorkspaceFileSystemExt::write_text_if_versionwhen the underlying object version no longer matches the expected version. - Workspace
Write Outcome - Result metadata for a write operation.
Enums§
- Workspace
Error - Error type returned by every
WorkspaceFileSystemand friend trait method. - Workspace
File Type - Directory entry kind.
Traits§
- Command
Output Observer - Observer that receives streaming output deltas from a workspace command.
- Workspace
Command Runner - Shell/command execution available to the
bashtool. - Workspace
File System - File operations available to built-in file tools.
- Workspace
File System Ext - Optional compare-and-swap extensions to
WorkspaceFileSystem. - Workspace
Git - Core Git operations supported by virtually every workspace Git backend.
- Workspace
GitStash Provider - Optional Git stash operations.
- Workspace
GitWorktree Provider - Optional Git worktree operations.
- Workspace
Path Resolver - Normalizes and validates host-supplied paths before they reach a backend.
- Workspace
Search - Search operations available to
globandgrep.
Type Aliases§
- Workspace
Result - Result alias used throughout the workspace trait surface in v3.0+.