LibTmux.Workspace.WorkspaceFile.FromSnapshot

API reference · Markdown

LibTmux.Workspace.WorkspaceFile.FromSnapshot ( session : Session ) → WorkspaceFile

methodstatic [source] ¶

Creates a workspace declaration from a captured session without reaching tmux.

Description#

Preserves captured window placements and pane order, names, layouts, and focus. Repeated links become separate declared windows. Captured pane directories escape literal dollars for a later explicit Resolve ; captured null paths remain unspecified. Commands, environment, options, terminal text, entity identifiers, pane indices, and shared-link identity are not reconstructed. Foreground command names do not establish shell intent. Restoring a native custom layout can change which pane occupies a position; see SelectLayoutAsync .

Parameters

• session ( Session ) – The session with captured windows, panes, and active pane relations.

Returns

An unresolved declaration without a document directory.

Raises

• ArgumentNullException – The session is null.

• IncompleteSnapshotException – A required field or relation was not captured.

• TmuxProtocolException – A captured window active flag is malformed.