LibTmux.Workspace.WorkspaceBuilder.BuildAsync
- LibTmux.Workspace.WorkspaceBuilder.BuildAsync ( workspace : WorkspaceFile , cancellationToken : CancellationToken ) Task<WorkspaceResult>
-
Builds a session from a workspace.
Readiness is inferred from the pane's current command and cursor position. Startup output can resemble a prompt, and a prompt left at the origin can time out; the builder never writes a readiness probe to the pane.
- Parameters
-
-
workspace ( WorkspaceFile ) – The workspace to build.
-
cancellationToken ( CancellationToken ) – Cancels the tmux commands.
-
- Returns
-
What was built, and what could not be.
- Raises
-
-
WorkspaceFormatException – The workspace describes no session.
-
WorkspaceBuildException – tmux failed after application began. The exception reports any materialized state.
-
Discussed in Build a workspace from a file · .NET workspace internals , .NET workspace builder API
In other ports Build a session from a workspace description
- Python
tmuxp.workspace.builder.ClassicWorkspaceBuilder.build - Ruby
LibTmux::Workspace::Plan#apply - Lua No source-verified Lua equivalent is recorded for this operation.
- TypeScript
builder.applyWorkspace - Rust
src.WorkspaceBuilder.build - Go
workspace.Build - Java
io.github.libtmux.workspace.WorkspaceBuilder.WorkspaceBuilder.build - C++
libtmux::workspace::build - Swift
WorkspaceBuilder.build(_:on:)