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_eio.Workspace

module Workspace

Public owner: Libtmux_eio

Apply workspace plans through Eio while retaining journals across caller cancellation. Handles belong to the creating domain; the application owns the scheduler and switch.

Guides#

Pages that discuss Workspace.

Members7#

Common operations1#

  • await function Apply steps at most once per execution handle. Expected failures return a retained journal. 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. Eio cancellation propagates after progress is recorded and at most 500 ms of protected compensation. Admitted commands can still complete under client ownership; use inspect before manual recovery.

Other members6#

  • 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.
  • close function Release an owned client through Client.close. Active await returns Busy. Closing is idempotent; completed journals remain readable.
  • 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 handle without I/O. The supplied client is borrowed; closing the handle leaves it open.
  • submit_bootstrap function Allocate a missing-endpoint execution without I/O. Await starts control new-session and binds that same connection. The handle owns its new client within sw; it never owns the daemon.
  • t typealias
Esc

Type to search.

Reference previewOpen reference