Auto Light Dark

Workspace ManagerAPI Reference

Choose documentation 3

latest

Current version

English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

.mobile-toolbar, .documentation-context-navigation, #mobile-sidebar, #mobile-toc { display: none !important; }

Browse documentation

Workspace ManagerAPI Reference

LibTmux.Workspace.WorkspaceOperationCanceledException

API reference · Markdown

class LibTmux.Workspace.WorkspaceOperationCanceledException class [source] ¶

Reports workspace cancellation and the tmux state materialized before it.

Discussed in C# workspace builder behavior , C# workspace builder API

Members

WorkspaceOperationCanceledException

WorkspaceOperationCanceledException ( partialResult : WorkspaceResult? , failure : OperationCanceledException , cancellationToken : CancellationToken ) method [source] ¶

Initializes a workspace cancellation exception.

Parameters

partialResult ( WorkspaceResult? ) – The materialized state, or null when none was read.
failure ( OperationCanceledException ) – The original cancellation.
cancellationToken ( CancellationToken ) – The caller token that canceled application.

PartialResult

PartialResult : WorkspaceResult? property [source] ¶: Gets the session and windows materialized before cancellation, when known.

Journal : IReadOnlyList<WorkspaceActionOutcome> property [source] ¶: Gets all planned action outcomes, even when no session was materialized.

CompensationJournal

CompensationJournal : IReadOnlyList<WorkspaceActionOutcome> property [source] ¶: Gets attempted cleanup outcomes and their failures without replacing the original cancellation.

Dispatch : TmuxDispatchState property [source] ¶: Gets the dispatch evidence from application.