Workspace ManagerAPI Reference

Choose documentation 3

latest

Current version

latest
English

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

LibTmux.Workspace.WorkspaceResult

API reference · Markdown

struct LibTmux.Workspace.WorkspaceResult
struct [source]

Describes workspace state materialized by a build.

Discussed in Use the C# workspace builder , C# workspace builder API

Members

WorkspaceResult

WorkspaceResult ( Session : Session , Windows : IReadOnlyList<Window> , Unsupported : IReadOnlyList<string> )
method [source]

Initializes a workspace result.

Parameters
  • Session ( Session ) – The session that was built.

  • Windows ( IReadOnlyList<Window> ) – The windows, in the order the file listed them.

  • Unsupported ( IReadOnlyList<string> ) – The layouts tmux rejected after creating their windows.

Session

Session : Session
property [source]

Gets the session materialized by the build.

Windows

Windows : IReadOnlyList<Window>
property [source]

Gets created windows in workspace order, or an empty list for Reuse.

Unsupported

Unsupported : IReadOnlyList<string>
property [source]

Gets the layouts tmux rejected after creating their windows.

Discussed in Use the C# workspace builder , C# workspace builder behavior

Journal

Gets every reviewed action's outcome, including actions not started after failure.

CompensationJournal

CompensationJournal : IReadOnlyList<WorkspaceActionOutcome>
property [source]

Gets conditional cleanup outcomes in the plan's cleanup order.

Equals

Equals ( other : WorkspaceResult? ) → bool
method [source]

GetHashCode

GetHashCode ( ) → int
method [source]

Deconstruct

Deconstruct ( Session : Session , Windows : IReadOnlyList<Window> , Unsupported : IReadOnlyList<string> ) → void
method [source]

Deconstructs the result into the built session, windows, and rejected layouts.

Parameters
Esc

Type to search.