Enum PaneWait 

#[non_exhaustive]
pub enum PaneWait {
    Arrived,
    Dead,
    TimedOut,
}

What came of waiting for a pane to do something.

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));

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Arrived

What was waited for happened.

Dead

The pane’s process ended before it happened. Waiting longer cannot change the answer, which is why this is not a timeout.

TimedOut

The time ran out with the pane still alive.

Trait Implementations

impl Clone for PaneWait

fn clone(&self) -> PaneWait

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for PaneWait

impl Debug for PaneWait

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for PaneWait

impl Hash for PaneWait

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for PaneWait

fn eq(&self, other: &PaneWait) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for PaneWait