Core LibraryunreleasedAPI 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.

module libtmux-ocaml latest

Libtmux.Snapshot

A complete immutable graph captured over an acquisition interval. Collections are replayable immutable arrays. Capturing several tmux commands does not establish an atomic transaction.

Source and package
Qualified name
Libtmux.Snapshot
Declared in
Libtmux
Package
libtmux
Source
lib/libtmux.mli
module Snapshot

Public owner: Libtmux

Members16#

Collections and queries4#

  • sessions function
  • windows function
  • panes function
  • clients function Collections and their contents are immutable. They retain capture order, are replayable and remain readable after the acquiring client closes.

Common operations3#

Other members9#

  • create function Validate and materialize a complete captured graph without I/O. Equal duplicate global rows collapse in first-occurrence order; conflicting rows and dangling references return Error.Capture_raced. Links at different indexes remain distinct, including within one session. At most 10,000 input rows are admitted. Each session needs one current link and each window one active pane. Capture spans an interval, not an atomic instant. Input strings are bytes; no Unicode normalization is performed.
  • finished_at_ns function
  • id function
  • Id module
  • Input module
  • source function
  • started_at_ns function
  • t typealias
  • window_links function
Esc

Type to search.

Reference previewOpen reference