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

module Execution

Public owner: Libtmux_workspace

Apply a plan once per handle and retain effects, uncertainty and cleanup. The journal lives in process memory while its execution handle is retained; Execution.inspect returns immutable copies. It survives waiter cancellation and client closure, but supplies no crash-durable recovery or cross-invocation deduplication. Ordinary applications use their backend's Workspace module; executors below integrate another transport.

Members13#

Common operations1#

Other members12#

  • await function 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.
  • certainty enum
  • cleanup struct
  • create function Allocate a retained handle without I/O. IDs have 1..64 ASCII letters, digits, underscores or hyphens. operation_id correlates receipts; it does not deduplicate handles. A new handle starts a new execution even if its ID matches an earlier one.
  • executor struct Backend integration: inspect returns a callback tied to the latest operation, reading only its retained state even after later submissions. protect bounds compensation and shields it from caller cancellation, reporting expected failures as Error. Ordinary callers use their backend's Workspace API.
  • hint struct A creation row received before daemon binding finished. Hints are not operational targets and are never eligible for automatic compensation.
  • inspect function Return an immutable copy of the retained journal without I/O.
  • observation struct
  • receipt struct
  • step struct
  • step_status enum
  • t typealias
Esc

Type to search.

Reference previewOpen reference