OCaml workspace API reference
libtmux-workspace · Source
Use Libtmux_workspace to validate configuration and build a plan without I/O.
Execute the plan through an explicit native client and retain its journal for
recovery. Libtmux_json decodes the versioned workspace JSON format.
The declarations below document the workspace library at this site’s source
revision. The workspace guide shows installation, planning,
execution and receipt inspection with tmux-workspace.
API declarations
Follow a declaration for its signature, members, documentation, and source.
Exports
Libtmux_workspace- Config validates workspace descriptions and Plan previews their actions without I/O. Execution delegates effects to an explicit executor and retains a recovery journal. See the workspace guide for JSON loading, preview, apply and receipt inspection.
Libtmux_eio.Workspace- Apply workspace plans through Eio while retaining journals across caller cancellation. Handles belong to the creating domain; the application owns the scheduler and switch.
Libtmux_json.Workspace- Validate workspace documents and describe plans and retained execution. Preview output never supplies executable targets.
Libtmux_unix.Workspace- 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.