Workspace ManagerconceptAPI Reference

Choose documentation 2

latest

Current version

latest
English

Unreleased libtmux has not been released. Its API may change during development. This site's structure and URLs may change too.

Workspace Manager: API Reference

Libtmux_unix.Workspace

module Workspace

Public owner: Libtmux_unix

Apply validated plans with blocking I/O and scoped cancellation tokens. Execution handles retain journals and borrow existing clients; bootstrap handles own their newly bound clients without owning the daemon.

Guides#

Pages that discuss Workspace.

Members7#

Common operations3#

  • await function Apply steps at most once per execution handle. Expected failures return retained receipts. On initial application, compensate_on_failure defaults to true, attempting removal of proven newly created panes after failure or cancellation. Passing false skips that compensation. Cancellation propagates after recording progress and at most 500 ms of protected compensation; use inspect afterward.
  • client function Borrow the existing or bootstrapped Client.t without I/O for subsequent actions or recovery. close releases a client owned by this workspace execution handle.
  • submit_bootstrap function Allocate a handle for a missing-endpoint plan. Awaiting it starts control new-session and binds the same connection. The handle owns its new client; it never acquires ownership of the daemon.

Other members4#

  • close function Release an owned client through Client.close. Active await returns Busy. Completed journals remain readable after close.
  • inspect function Copy the retained Libtmux_workspace.Execution.receipt without I/O, on the owning domain, including after execution or client closure. Pending steps can settle as the client progresses; earlier receipts keep their own step and cleanup arrays.
  • submit function Allocate a generation-bound execution handle without I/O. The caller owns the supplied client; closing this handle leaves that client open.
  • t typealias
Esc

Type to search.

Reference previewOpen reference