LibTmux.Workspace 0.0.0-alpha.14 · Source
The LibTmux.Workspace namespace provides configuration objects and a builder
that uses a caller-supplied LibTmux Server.
ConfigurationLink to section
WorkspaceFile parses
YAML and holds the session description. WorkspaceWindow and WorkspacePane
hold nested configuration. WorkspaceFormatException identifies unsupported
or invalid configuration.
Builder optionsLink to section
WorkspaceBuilder
accepts a server, an optional positive readiness timeout, and a
PaneReadiness policy.
Its BuildAsync accepts the configuration and an optional cancellation token.
The default timeout is ten seconds. Auto, Always, and Never select which
panes wait before command delivery. Topics explains the prompt
heuristic and its limitations.
Results and failuresLink to section
WorkspaceResult
contains the created session, windows, and rejected layouts. A rejected 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. Inspect live tmux state before
retrying; a missing result does not prove that no command reached tmux.
Result contract; Failure contract.
API declarations
Follow a declaration for its signature, members, documentation, and source.
Exports
LibTmux.Workspace.PaneReadiness- Controls whether workspace panes wait for a prompt-like state.
LibTmux.Workspace.WorkspaceBuilder- Builds a tmux session from a tmuxp workspace file.
LibTmux.Workspace.WorkspaceBuildException- Reports a workspace failure and the tmux state created before it.
LibTmux.Workspace.WorkspaceFile- Describes the supported subset of one tmuxp workspace.
LibTmux.Workspace.WorkspaceFormatException- Thrown when a workspace file cannot be read.
LibTmux.Workspace.WorkspacePane- Describes one pane in a supported tmuxp workspace.
LibTmux.Workspace.WorkspaceResult- Describes workspace state materialized by a build.
LibTmux.Workspace.WorkspaceWindow- Describes one window in a supported tmuxp workspace.