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

ChannelWait

What came of waiting on a wait-for channel.

Source and package
Qualified name
libtmux::server::ChannelWait
Module
server
Package
libtmux
Source
crates/libtmux/src/server.rs
enum server.ChannelWait

Description#

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

Examples#

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

Variants2#

ChannelWait variants
CasePayloadDescription
Signalled No payload Something signalled the channel, or a signal was already waiting.
TimedOut No payload The time ran out with the channel unsignalled.

Guides#

Pages that discuss ChannelWait.

Esc

Type to search.

Reference previewOpen reference