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.

Rust API

method libtmux-rs latest

Error.is_transient

Report whether retrying the same call unchanged is safe and may succeed.

Source and package
Qualified name
libtmux::error::Error::is_transient
Module
error
Declared in
Error
Package
libtmux
Source
crates/libtmux/src/error/classification.rs
#[must_use] pub fn is_transient(&self) -> bool

Description#

true means this error proves that the requested mutation did not run, or came from an operation that only reads state. The condition may need to clear first: capacity can become available, a client can resume, a resource-limited spawn can be retried, or a server can answer again.

false does not mean that the handle is unusable. A subprocess timeout, output-reader failure, child-wait failure, or lost supervisor can leave the executor ready for another call, but tmux may already have carried out the first one. Replaying a mutation could duplicate its effect. A shut down executor and a closed or timed-out control connection are also false because they require a new server or connection.

Esc

Type to search.

Reference previewOpen reference