LibTmux.Workspace.WorkspaceBuilder.PlanAsync

API reference · Markdown

LibTmux.Workspace.WorkspaceBuilder.PlanAsync ( workspace : WorkspaceFile , options : WorkspacePlanOptions? , cancellationToken : CancellationToken ) → Task<WorkspacePlan>

methodasync [source] ¶

Observes the endpoint and constructs an immutable workspace action plan.

Parameters

• workspace ( WorkspaceFile ) – The immutable declaration, resolved explicitly when file-relative paths are needed.

• options ( WorkspacePlanOptions? ) – The conflict, readiness and cleanup policies.

• cancellationToken ( CancellationToken ) – Cancels read-only endpoint observation.

Returns

The actions and observed identity preconditions; no workspace actions are executed.

Raises

• WorkspaceFormatException – The declaration cannot be applied.

• TmuxSessionExistsException – The default policy refuses an existing session.

• ArgumentException – The endpoint has an opaque initializer or the options are invalid.

Discussed in C# workspace builder API