C# workspace builder API

LibTmux.Workspace 0.0.0-alpha.20 · Source

The LibTmux.Workspace namespace provides configuration objects and a builder that uses a caller-supplied LibTmux Server.

Configuration¶

WorkspaceFile parses YAML and holds the session description. WorkspaceWindow and WorkspacePane hold nested configuration. WorkspaceFormatException identifies unsupported or invalid configuration.

Builder options¶

WorkspaceBuilder accepts the server to use. PlanAsync validates the declaration and observes that endpoint; its returned WorkspacePlan lists the actions to review before ApplyAsync executes them. Enumerating those actions performs no I/O. Application rechecks the observed daemon and session.

WorkspacePlanOptions controls existing-session conflicts, readiness, host scripts, and cleanup. The defaults refuse an existing session and send pane input immediately. BuildAsync combines planning and application with those defaults.

Choose WorkspaceReadiness.Cooperative when pane startup can signal its assigned channel. Configure a positive ReadinessTimeout; a timeout prevents command delivery to that pane. Topics explains the startup contract and its limits.

Results and failures¶

WorkspaceResult contains the session, created windows, rejected final layouts, and action journals. Reusing an existing session creates no windows. A rejected final layout does not discard its window.

WorkspaceBuildException keeps a PartialResult when state could be materialized before failure. It can be null when no such result could be read. Journal records action outcomes; CompensationJournal records attempted cleanup. Inspect live tmux state before retrying; a missing result does not prove that no command reached tmux.

Cancellation during application raises WorkspaceOperationCanceledException with the caller’s token, partial state, and journals. Cancellation does not imply rollback. CompensateOnFailure requests bounded cleanup only of resources proven to belong to that application.

Result contract; Failure contract.