Swift workspace internals
TmuxWorkspace 0.1.0-alpha.5 · Source
These pages document the in-development workspace builder for contributors and applications that call its APIs. For workspace loading from a terminal, see tmuxp.
Builder pipelineLink to section
Workspace holds typed configuration or decodes JSON and optional YAML.
WorkspaceBuilder.build applies that description through an async core
Server. The caller supplies file reading, server startup, command-line
handling, and attachment.
Read the implementationLink to section
- Guides show builder setup and application code.
- Topics explain configuration, behavior, and failures.
- Examples exercise the builder through the language API.
- API links the configuration and construction interfaces.
Implementation scopeLink to section
TmuxWorkspace builds a tmux session from Swift values or a
tmuxp-style configuration. It is a SwiftPM
library product beside the core LibTmux product.
Swift and JSON descriptions work without a YAML dependency. Enable the
YAMLWorkspaces package trait to add YAML decoding. Building uses the same
async core server API under either format.
Existing sessions and versionsLink to section
The builder refuses an existing session with the requested name. On a later failure, it attempts to remove the exact session it created and reports both errors if cleanup also fails.
These pages describe the current source API. The port distinguishes its unreleased source examples from the released alpha package. Use a matching source revision for these examples, or consult the release’s own README when pinning a published version.