Skip to main content

Module workspace

Module workspace 

Source
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§

CommandOutput
Command execution output.
CommandRequest
Command execution request.
LocalWorkspaceBackend
Local filesystem-backed workspace implementation.
RemoteGitBackend
Client for a remote gitserver. See module docs / RFC for the protocol.
RemoteGitBackendConfig
Configuration for a RemoteGitBackend.
RemoteGitConflict
Error returned for HTTP 409 / 422 responses that carry a recoverable failure code. Tools downcast with anyhow::Error::downcast_ref to react — for example, retrying after a WORKING_TREE_DIRTY by stashing first.
VirtualPathResolver
Lexical resolver suitable for virtual/browser/DFS workspaces.
WorkspaceCapabilities
Workspace capability flags used to gate which built-in tools are registered.
WorkspaceDirEntry
Directory entry returned by a workspace backend.
WorkspaceGitBranch
Branch information returned by a workspace Git provider.
WorkspaceGitCheckoutOutput
Checkout output returned by a workspace Git provider.
WorkspaceGitCheckoutRequest
Checkout request for a workspace Git provider.
WorkspaceGitCommit
Commit information returned by a workspace Git provider.
WorkspaceGitCreateBranchRequest
Branch creation request for a workspace Git provider.
WorkspaceGitCreateWorktreeRequest
Worktree creation request for a workspace Git provider.
WorkspaceGitDiffRequest
Diff request for a workspace Git provider.
WorkspaceGitRemote
Remote information returned by a workspace Git provider.
WorkspaceGitRemoveWorktreeRequest
Worktree removal request for a workspace Git provider.
WorkspaceGitStash
Stash information returned by a workspace Git provider.
WorkspaceGitStashRequest
Stash request for a workspace Git provider.
WorkspaceGitStatus
Repository status returned by a workspace Git provider.
WorkspaceGitWorktree
Worktree information returned by a workspace Git provider.
WorkspaceGitWorktreeMutation
Mutation result for workspace Git worktree operations.
WorkspaceGlobRequest
Glob request for workspace-backed search.
WorkspaceGlobResult
Glob result returned by a workspace search provider.
WorkspaceGrepRequest
Grep request for workspace-backed search.
WorkspaceGrepResult
Grep result returned by a workspace search provider.
WorkspacePath
A normalized virtual path inside a workspace.
WorkspaceRef
Identity and display metadata for a workspace.
WorkspaceServices
The host-provided workspace capability bundle used by tool execution.
WorkspaceServicesBuilder
Builder for assembling workspace services without constructor arity churn.
WorkspaceVersionConflict
Error returned by WorkspaceFileSystemExt::write_text_if_version when the underlying object version no longer matches the expected version.
WorkspaceWriteOutcome
Result metadata for a write operation.

Enums§

WorkspaceError
Error type returned by every WorkspaceFileSystem and friend trait method.
WorkspaceFileType
Directory entry kind.

Traits§

CommandOutputObserver
Observer that receives streaming output deltas from a workspace command.
WorkspaceCommandRunner
Shell/command execution available to the bash tool.
WorkspaceFileSystem
File operations available to built-in file tools.
WorkspaceFileSystemExt
Optional compare-and-swap extensions to WorkspaceFileSystem.
WorkspaceGit
Core Git operations supported by virtually every workspace Git backend.
WorkspaceGitStashProvider
Optional Git stash operations.
WorkspaceGitWorktreeProvider
Optional Git worktree operations.
WorkspacePathResolver
Normalizes and validates host-supplied paths before they reach a backend.
WorkspaceSearch
Search operations available to glob and grep.

Type Aliases§

WorkspaceResult
Result alias used throughout the workspace trait surface in v3.0+.