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

LibTmux::Workspace::Plan

Ruby

Python Unavailable
Ruby
Lua Unavailable
TypeScript Unavailable
Rust Unavailable
Go Unavailable
Java Unavailable
.NET Unavailable
C++ Unavailable
Swift Unavailable

API reference · Markdown

class LibTmux::Workspace::Plan classlibtmux-workspace [source] ¶ classlibtmux-workspace [source] ¶ class LibTmux::Workspace::Plan

Members

Step classlibtmux-workspace [source] ¶ classlibtmux-workspace [source] ¶ Step

apply ( server : ::LibTmux::Server , timeout : ::Numeric = nil , cancel : untyped = nil , compensate : bool = nil ) → ::LibTmux::Workspace::ApplyResult methodlibtmux-workspace [source] ¶ methodlibtmux-workspace [source] ¶ apply

Behavior: Workspace apply.

Behavior contract: Workspace apply.

Discussed in libtmux-workspace

In other ports Build a session from a workspace description

Python tmuxp.workspace.builder.ClassicWorkspaceBuilder.build
Lua No source-verified Lua equivalent is recorded for this operation.
TypeScript builder.applyWorkspace
Rust src.WorkspaceBuilder.build
Go workspace.Build
Java io.github.libtmux.workspace.WorkspaceBuilder.WorkspaceBuilder.build
.NET LibTmux.Workspace.WorkspaceBuilder.BuildAsync
C++ libtmux::workspace::build
Swift WorkspaceBuilder.build(_:on:)

inspect ( ) → ::String methodlibtmux-workspace [source] ¶ methodlibtmux-workspace [source] ¶ inspect: Behavior: Workspace plans.

Behavior contract: Workspace plans.

mode ( ) → (:offline_create | :captured_create) methodlibtmux-workspace [source] ¶ methodlibtmux-workspace [source] ¶ mode: Returns the value of attribute mode.

Behavior contract: Workspace plans.

preconditions

preconditions ( ) → ::Hash[::String, ::String?] methodlibtmux-workspace [source] ¶ methodlibtmux-workspace [source] ¶ preconditions: Returns the value of attribute preconditions.

Behavior contract: Workspace plans.

steps ( ) → ::Array[::LibTmux::Workspace::Plan::Step] methodlibtmux-workspace [source] ¶ methodlibtmux-workspace [source] ¶ steps: Returns the value of attribute steps.

Behavior contract: Workspace plans.

to_h ( ) → ::Hash[::String, untyped] methodlibtmux-workspace [source] ¶ methodlibtmux-workspace [source] ¶ to_h: Behavior: Workspace plans.

Behavior contract: Workspace plans.

new ( arg1 : ::LibTmux::Workspace , snapshot : ::LibTmux::Snapshot? = nil ) → ::LibTmux::Workspace::Plan methodlibtmux-workspacestatic [source] ¶ methodlibtmux-workspacestatic [source] ¶ new: Behavior: Workspace plans.

Behavior contract: Workspace plans.