WorkspaceBuilder

Swift

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

enum WorkspaceBuilder : enum WorkspaceBuilder enum [source] ¶ enum [source] ¶ enum WorkspaceBuilder

Builds a workspace on a tmux server.

This is a consumer of LibTmux, not part of it: everything here goes through the same public surface any other caller has, which is the point — if building a real layout needs something the library does not expose, that is the library's problem to fix.

Discussed in Swift workspace builder API

Members

build(_:on:)

build(_:on:) ( workspace : Workspace , on : Server ) → Session methodasyncstatic [source] ¶ methodasyncstatic [source] ¶ build(_:on:)

Creates the workspace's session and returns it.

Fails rather than adopting an existing session of the same name: two callers building the same workspace should not silently share one. A failure after creation removes that exact session. If cleanup also fails, WorkspaceBuilderError/rollbackFailed(original:cleanup:) reports both errors.

Raises

WorkspaceBuilderError

Discussed in Build a workspace from a file · Swift workspace internals , Swift 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
Rust src.WorkspaceBuilder.build
Go workspace.Build
Java io.github.libtmux.workspace.WorkspaceBuilder.WorkspaceBuilder.build
.NET LibTmux.Workspace.WorkspaceBuilder.BuildAsync
C++ libtmux::workspace::build