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

constant libtmux-rs latest

Error.ClientSuspended

A client is stopped rather than gone, so listings leave it out.

Source and package
Qualified name
libtmux::error::Error::ClientSuspended
Module
error
Declared in
Error
Package
libtmux
Source
crates/libtmux/src/error.rs
ClientSuspended { name: String, }

Description#

Distinct from Self::ObjectGone, and the distinction decides whether to drop the handle: a suspended client is still on the server and is listed again once it resumes, so the same handle keeps working. Self::ObjectGone means it will not.

tmux omits a suspended client from list-clients while still resolving it as a command target, which is what makes the two tellable apart. The listing filters the dead, the exiting and the suspended together, so absence from it does not say which of the three happened.

Both crate::Client::suspend() and locking a client arrive here, because tmux marks them with one flag. A client resumes when its process continues -- the suspended one on SIGCONT, the locked one when its lock-command exits.

Fields1#

ClientSuspended fields
NameTypeDescription
name String The client's tmux name, which is the path of its terminal.
Esc

Type to search.

Reference previewOpen reference