Enum ErrorKind 

#[non_exhaustive]
pub enum ErrorKind {
    PartialEffect,
    ObjectGone,
    Refused,
    ServerGone,
    Timeout,
    Unreachable,
    UnsupportedVersion,
    InvalidInput,
    Transport,
    Decode,
}

A coarse failure category for reporting and routing.

Error carries the recovery detail. One category can contain failures with different retry scopes: overload and a bad argument are both refused, while executor shutdown and a failed child pipe are both transport errors. Use Error::is_transient before repeating a call unchanged.

New kinds may be added, so match with a _ arm.

Examples

use libtmux::ErrorKind;

fn target_is_stale(kind: ErrorKind) -> bool {
    matches!(kind, ErrorKind::ObjectGone)
}

assert!(target_is_stale(ErrorKind::ObjectGone));
assert!(!target_is_stale(ErrorKind::InvalidInput));

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.

PartialEffect

tmux accepted an effectful step before a later part of the operation failed.

ObjectGone

The object is not on the server. Look it up again, or create it.

Refused

The operation was refused before or by tmux.

ServerGone

No tmux server answered. Start one, or name the socket that has it.

Timeout

The operation did not finish in time.

Unreachable

tmux could not be run at all: not installed, or not where the server was told to look. Nothing about the request will change this.

UnsupportedVersion

The tmux that answered is older than this crate supports.

InvalidInput

The caller supplied inputs that cannot form a valid operation.

Transport

The process, connection, or executor carrying the command failed.

Decode

tmux answered in a shape the crate could not read. Worth reporting.

Trait Implementations

impl Clone for ErrorKind

fn clone(&self) -> ErrorKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ErrorKind

impl Debug for ErrorKind

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

Formats the value using the given formatter.

impl Eq for ErrorKind

impl Hash for ErrorKind

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 ErrorKind

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ErrorKind