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_workspace.Execution.await

val await : ?compensate_on_failure:bool -> t -> receipt

Public owner: Libtmux_workspace

Execute once per handle, rechecking generation and captured preconditions first. Expected failures return a partial journal. Exceptions, including native cancellation, propagate after recording progress and bounded compensation. Subsequent calls only return the retained receipt; mutations never retry.

Description#

Compensation kills only panes reported by completed creation commands, in reverse creation order. tmux removes windows and sessions that become empty. Containers with foreign panes or window links remain; adding a borrowed pane never makes it eligible for cleanup. Cleanup failures have separate outcomes. Compensation cannot undo external effects of programs started inside the panes.

Parameters
Esc

Type to search.

Reference previewOpen reference