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.

function libtmux-ocaml latest

Client.wait_for_text

Subscribe and capture the screen immediately, then recapture on output. Membership/overflow gaps establish fresh coverage in the same binding. Maximum pattern: 64 KiB. Return captured rendered text containing it; transient text may be missed. Deadlines are checked between bounded acquisitions, whose I/O retains the client exchange timeout. Cancellation propagates and releases the subscription. A cleanup failure cannot replace an earlier error or cancellation; inspect cleanup for secondary failures. Otherwise cleanup failure prevents success or renewed coverage. No history/barrier guarantee.

Source and package
Qualified name
Libtmux_eio.Client.wait_for_text
Module
Libtmux_eio
Declared in
Client
Package
libtmux-eio
Source
eio/libtmux_eio.mli
val wait_for_text : ?timeout:float -> ?scratch_dir:string -> t -> Libtmux.Pane.t -> text:string -> (Rendered.t, Libtmux.Error.t) result

Public owner: Libtmux_eio

Parameters
Esc

Type to search.

Reference previewOpen reference