Module workspace 

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

ChunkCatalogLimits

Hard catalog bounds checked before publishing a replacement.

ChunkCatalogSnapshot

Immutable, query-safe view of one catalog revision.

ChunkingConfig

Deterministic chunking limits.

CommandOutput

Command execution output.

CommandOutputSummary

Final accounting for a bounded command-output capture.

CommandRequest

Command execution request.

FixedWindowChunkingOptions

Options for fixed UTF-8 byte windows with bounded overlap.

LexicalSearchHit

LexicalSearchRequest

LexicalSearchResult

LocalWorkspaceBackend

Local filesystem-backed workspace implementation.

LocalWorkspaceFile

One manifest entry.

LocalWorkspaceManifest

Shared in-memory workspace manifest.

LocalWorkspaceManifestSnapshot

Immutable manifest snapshot.

ManifestWorkspaceBackend

Local backend that uses an in-memory manifest for search.

RecentWorkspaceFile

Recency/usage score for a workspace file the user or agent touched.

RecursiveChunkingOptions

Options for recursive separator-aware text splitting.

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.

WorkspaceChunk

One bounded source chunk admitted to workspace retrieval.

WorkspaceChunkCatalog

Atomic, bounded, session-owned catalog of workspace source chunks.

WorkspaceChunkId

Stable identifier for one deterministic workspace chunk.

WorkspaceChunkRange

One zero-based, half-open UTF-8 byte range proposed by a chunking strategy.

WorkspaceChunkingInput

Redacted input supplied to a host-owned custom chunking strategy.

WorkspaceDirEntry

Directory entry returned by a workspace backend.

WorkspaceEligibilityPolicy

Conservative sensitive-path rules for files retained in the local catalog.

WorkspaceEmbeddingBatchMetrics

Machine-readable batching evidence for the current catalog generation.

WorkspaceFileChange

A filesystem change for one normalized workspace-relative file path.

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.

WorkspaceGrepOutcome

Grep result plus structured source evidence when supplied by a backend.

WorkspaceGrepRequest

Grep request for workspace-backed search.

WorkspaceGrepResult

Grep result returned by a workspace search provider.

WorkspaceHybridChannelRank

One channel rank that contributed to a fused hit.

WorkspaceHybridChannelStatus

Per-channel evidence included with every hybrid result.

WorkspaceHybridSearchHit

One current-source-verified fused match.

WorkspaceHybridSearchRequest

Bounded request for deterministic hybrid workspace retrieval.

WorkspaceHybridSearchResult

Fused results plus the exact semantic and catalog state used to build them.

WorkspacePath

A normalized virtual path inside a workspace.

WorkspaceRef

Identity and display metadata for a workspace.

WorkspaceRerankOptions

Explicit bounded configuration for hybrid second-stage ranking.

WorkspaceRerankStatus

Non-sensitive accounting for one bounded hybrid rerank operation.

WorkspaceRetrievalOptions

Typed, host-owned semantic retrieval configuration for one session.

WorkspaceRetrievalRuntime

Session-owned asynchronous projection from workspace chunks to vectors.

WorkspaceRetrievalStatus

Non-sensitive, immutable observation of one semantic index revision.

WorkspaceSemanticIndexLimits

Resource limits for one session-owned semantic workspace index.

WorkspaceSemanticSearchHit

One digest-verified semantic match from an immutable catalog revision.

WorkspaceSemanticSearchRequest

Bounded request for semantic workspace retrieval.

WorkspaceSemanticSearchResult

Structured semantic results and the exact status that produced them.

WorkspaceServices

The host-provided workspace capability bundle used by tool execution.

WorkspaceServicesBuilder

Builder for assembling workspace services without constructor arity churn.

WorkspaceTextRange

A bounded text range returned by an optional streaming workspace reader.

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

LocalWorkspaceAccessPolicy

Optional access policy for the local workspace backend.

LocalWorkspaceFileStatus

Git/workspace status for a file in the manifest.

WorkspaceChunkingError

Bounded failure returned by built-in or host-owned chunking code.

WorkspaceChunkingStrategy

Built-in and host-injected workspace chunking strategies.

WorkspaceError

Error type returned by every WorkspaceFileSystem and friend trait method.

WorkspaceFileChangeKind

The normalized kind of a workspace file change.

WorkspaceFileType

Directory entry kind.

WorkspaceHybridFallbackReason

Why one hybrid channel or the final fused result is partial.

WorkspaceIndexError

WorkspaceRerankAlgorithm

Versioned ranking pipeline actually applied to one hybrid result.

WorkspaceRerankFallbackReason

Why an explicitly requested reranker preserved the original RRF order.

WorkspaceRerankMode

Requested or applied second-stage ranking behavior.

WorkspaceRetrievalChannel

Independent retrieval evidence channels fused by hybrid search.

WorkspaceRetrievalError

Construction failures for a session semantic retrieval runtime.

WorkspaceRetrievalPhase

Lifecycle state of a session’s semantic workspace index.

WorkspaceSemanticFallbackReason

Explicit reason a semantic query could not run or returned partial data.

Traits

CommandOutputObserver

Observer that receives streaming output deltas from a workspace command.

CustomWorkspaceChunkingStrategy

Host extension point for deterministic workspace text splitting.

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.

WorkspaceTextReader

Optional streaming text capability for backends that can avoid loading a complete file when a caller needs only a line range.

Functions

scan_workspace_files

Type Aliases

WorkspaceResult

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

WorkspaceRetrievalResult