LibTmux.Workspace.WorkspaceBuilder.BuildAsync

API reference · Markdown

LibTmux.Workspace.WorkspaceBuilder.BuildAsync ( workspace : WorkspaceFile , cancellationToken : CancellationToken ) → Task<WorkspaceResult>

methodasync [source] ¶

Plans and applies a workspace with the default policies.

Description#

Uses the same plan and application engine as explicit PlanAsync and ApplyAsync. Input is sent immediately, without claiming shell readiness or command completion. Use an explicit plan to review actions or select readiness, conflict, host-script and compensation policies.

Parameters

• workspace ( WorkspaceFile ) – The workspace to build.

• cancellationToken ( CancellationToken ) – Cancels planning or application.

Returns

The materialized result and complete action journal.

Raises

• WorkspaceFormatException – The workspace declaration is invalid.

• TmuxSessionExistsException – The requested session already exists.

• WorkspaceOperationCanceledException – The caller canceled application; the exception carries state and action journals.

• WorkspaceBuildException – Application failed; the exception carries the action journal.

Discussed in C# workspace internals , C# workspace builder examples , Use the C# workspace builder , C# 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.build
• C++ libtmux::workspace::build
• Swift WorkspaceBuilder.build(_:on:)
• Kotlin No source-verified Kotlin equivalent is recorded for this operation.
• Scala No source-verified Scala equivalent is recorded for this operation.
• F# No source-verified F# equivalent is recorded for this operation.