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.

enum libtmux-rs latest

PaneWait

What came of waiting for a pane to do something.

Source and package
Qualified name
libtmux::pane::PaneWait
Module
pane
Package
libtmux
Source
crates/libtmux/src/pane.rs
enum pane.PaneWait

Description#

Running out of time is an outcome rather than an error, because a caller retries "it has not happened yet" and "tmux could not be reached" differently, and an error kind would make them look alike.

Examples#

use libtmux::PaneWait;
fn keep_waiting(outcome: PaneWait) -> bool {
matches!(outcome, PaneWait::TimedOut)
}
assert!(keep_waiting(PaneWait::TimedOut));
assert!(!keep_waiting(PaneWait::Dead));

Variants3#

PaneWait variants
CasePayloadDescription
Arrived No payload What was waited for happened.
Dead No payload The pane's process ended before it happened. Waiting longer cannot change the answer, which is why this is not a timeout.
TimedOut No payload The time ran out with the pane still alive.
Esc

Type to search.

Reference previewOpen reference