Skip to main content

Module api

Module api 

Source
Expand description

Re-exports the Corsa stdio API bindings.

Modules§

api
Typed bindings for the Corsa stdio API surface. Typed request/response layer for the Corsa stdio API.
error
Re-exports shared error types used by the client APIs.
jsonrpc
Re-exports low-level JSON-RPC helpers used by the stdio client transport.
lsp_types
Re-exports shared LSP model types used by editor-style API responses.
observability
Re-exports structured operational events used by the client configs.
process
Re-exports process-spawning primitives used to launch Corsa.

Structs§

ApiClient
High-level client for the Corsa stdio API.
ApiProfile
Named API profile reused by orchestrators and caches.
ApiProfileEvent
Single profiling sample emitted by the optional API profiler.
ApiSpawnConfig
Process configuration for spawning a Corsa API worker.
CapabilitiesResponse
Runtime capability summary returned by describeCapabilities.
ConfigResponse
Parsed tsconfig metadata returned by parseConfigFile.
DiagnosticsCapabilities
Diagnostics API support grouped by scope.
DirectoryEntries
Directory listing returned by getAccessibleEntries.
DocumentPosition
A UTF-16 position inside a document.
EditorCapabilities
Editor API support grouped by feature.
EncodedPayload
Opaque binary payload returned by binary Corsa endpoints.
FileChangeSummary
Per-file snapshot delta grouped by operation kind.
FileDiagnosticsResponse
Diagnostics for a single file grouped by TypeScript category.
FileSystemCapabilities
Declares which filesystem callbacks are implemented by an ApiFileSystem.
IndexInfo
Index signature information returned by checker queries.
InitializeResponse
Response returned by the initialize endpoint.
ManagedSnapshot
Live snapshot handle with automatic release-on-drop semantics.
NodeHandle
Opaque handle returned by Corsa.
OverlayCapabilities
Overlay support exposed by the runtime.
OverlayChanges
Overlay delta accepted by updateSnapshot.
OverlayUpdate
In-memory document update applied through updateSnapshot.
PrintNodeOptions
Formatting knobs accepted by the printNode endpoint.
ProjectDiagnosticsResponse
Diagnostics for every file in a project.
ProjectHandle
Opaque handle returned by Corsa.
ProjectResponse
Project descriptor returned by endpoints that resolve a project handle.
ProjectSession
Snapshot-backed project session for repeated checker queries.
RuntimeCapabilities
Runtime identity details for the active worker.
SignatureHandle
Opaque handle returned by Corsa.
SignatureResponse
Call signature metadata returned by checker-oriented endpoints.
SnapshotChanges
Project-level delta information returned by Corsa.
SnapshotDiagnosticsResponse
Diagnostics for every project in a snapshot.
SnapshotHandle
Opaque handle returned by Corsa.
SymbolHandle
Opaque handle returned by Corsa.
SymbolResponse
Symbol metadata returned by Corsa.
TypeHandle
Opaque handle returned by Corsa.
TypePredicateResponse
Type predicate metadata such as value is Foo.
TypeProbe
Aggregated checker view of a type at a single query site.
TypeProbeOptions
Options that control how much checker detail is loaded for a type probe.
TypeResponse
Type metadata returned by checker-oriented endpoints.
UpdateSnapshotParams
Parameters passed to ApiClient::update_snapshot.

Enums§

ApiMode
Transport mode used to talk to the Corsa API.
ApiProfilePhase
Fine-grained client request phase used by optional profiling hooks.
CorsaError
Workspace-wide error type for process, transport, and protocol failures.
CorsaEvent
Structured runtime events that embedders can observe.
DocumentIdentifier
File or URI identifier accepted by Corsa API endpoints.
FileChanges
Change payload accepted by updateSnapshot.
ReadFileResult
Result of a readFile callback.

Traits§

ApiFileSystem
Filesystem interface exposed to Corsa.
ApiProfiler
Sink for fine-grained API profiling samples.
CorsaObserver
Sink for structured operational events emitted by the workspace.

Functions§

callback_flag
Renders the --callbacks=... argument for a filesystem implementation.
callback_names
Returns the enabled callback names in the order expected by Corsa.

Type Aliases§

Result
Standard result alias used across the workspace.
SharedObserver
Shared observer handle used across configs and transports.
SharedProfiler
Shared profiler handle passed through spawn configs and clients.