Core Library0.xAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

method libtmux-rs latest

CaptureOptions.pending_escape

Capture the escape sequence the pane has begun but not finished.

Source and package
Qualified name
libtmux::pane::CaptureOptions::pending_escape
Module
pane
Declared in
CaptureOptions
Package
libtmux
Source
crates/libtmux/src/pane.rs
#[must_use = "options describe a capture but do not perform one" ] pub const fn pending_escape(mut self) -> Self

Description#

tmux's -P, and narrower than it sounds: the answer is only the bytes of an escape sequence that arrived incomplete, not output waiting to be drawn. A pane in the middle of nothing answers with nothing. It diagnoses a program that stopped mid-sequence; it is not a way to read output early.

Examples#

use libtmux::CaptureOptions;
let partial = CaptureOptions::visible().pending_escape();
assert_ne!(partial, CaptureOptions::visible());
Esc

Type to search.

Reference previewOpen reference