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

src.WorkspaceBuilder.build

Rust

API reference · Markdown

src.WorkspaceBuilder.build ( self , workspace : &Workspace ) → Result<Session, BuildError> method [source] ¶ method [source] ¶ src.WorkspaceBuilder.build

Create the session a workspace describes, and return it.

Windows and panes are created in the order the configuration lists them. Nothing is attached: the caller decides whether to take over a terminal.

Errors

Returns an error when a session of the same name exists, or when tmux refuses any step.

Discussed in Use the Rust workspace builder , Rust workspace builder behavior , Rust workspace builder API

In other ports Build a session from a workspace description

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