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, capture the ordinary screen immediately, and recapture after output. Membership/overflow gaps trigger explicit fresh capture and new coverage in the same binding. Maximum pattern: 64 KiB. Success returns a capture that contains the text. Transient text between captures may be missed. Check the deadline between bounded acquisitions; in-flight I/O retains the client's exchange timeout. Release the temporary subscription without replacing an earlier error or cancellation; inspect cleanup for secondary failures. Otherwise cleanup failure prevents success or renewed coverage. No capture/stream barrier exists.

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

Public owner: Libtmux_unix

Parameters
Esc

Type to search.

Reference previewOpen reference