LibTmux.Workspace.WorkspaceFile

.NET

class LibTmux.Workspace.WorkspaceFile class [source] ¶ class [source] ¶ class LibTmux.Workspace.WorkspaceFile

Describes the supported subset of one tmuxp workspace.

Parsing rejects keys that require tmuxp's Python hooks or plugins. It does not execute or silently discard configuration outside this model.

In other ports Describe a workspace as data

Python tmuxp uses configuration dictionaries rather than a dedicated workspace value type
Ruby LibTmux::Workspace
Lua No source-verified Lua equivalent is recorded for this operation.
TypeScript config.Workspace
Rust config.Workspace
Go workspace.Workspace
Java io.github.libtmux.workspace.Workspace.Workspace
C++ libtmux::workspace::Workspace
Swift Workspace

Members

WorkspaceFile ( sessionName : string? , startDirectory : string? , options : IReadOnlyDictionary<string, string>? , windows : IReadOnlyList<WorkspaceWindow>? ) method [source] ¶ method [source] ¶ WorkspaceFile

Initializes a workspace description.

Parameters

sessionName ( string? ) – The session name.
startDirectory ( string? ) – The directory its windows start in.
options ( IReadOnlyDictionary<string, string>? ) – The session options to set.
windows ( IReadOnlyList<WorkspaceWindow>? ) – The windows to create, in order.

SessionName : string? property [source] ¶ property [source] ¶ SessionName: Gets the session name.

StartDirectory : string? property [source] ¶ property [source] ¶ StartDirectory: Gets the directory its windows start in.

Options : IReadOnlyDictionary<string, string> property [source] ¶ property [source] ¶ Options: Gets the session options to set.

Windows : IReadOnlyList<WorkspaceWindow> property [source] ¶ property [source] ¶ Windows: Gets the windows to create, in order.

Parse ( yaml : string ) → WorkspaceFile methodstatic [source] ¶ methodstatic [source] ¶ Parse

Reads a workspace from tmuxp YAML.

Parameters

Returns

The parsed workspace.

Raises

WorkspaceFormatException – The input is too large, malformed, contains more than one document, or uses a key or value shape outside the supported subset.