Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

client.Client.suspend

Rust
  • Python Unavailable
  • TypeScript Unavailable
  • Rust
  • Go Unavailable
  • Java Unavailable
  • .NET Unavailable
  • C++ Unavailable
  • Swift Unavailable

View as Markdown

Module
client
Declared in
Client
Package
libtmux
Source
crates/libtmux/src/client.rs
suspend ( self ) → Result<(), Error>
method [source]
method [source]
suspend

Suspend this client, as if its user pressed the suspend key.

The handle survives, and deliberately: unlike Self::detach , this stops the client rather than ending it. tmux stops listing a suspended client, so Server::clients will not show it and the session stops counting it as attached, but it is still there. It returns when its process continues, which for a suspended client is SIGCONT.

Errors

Returns an error when tmux refuses the command. Reading through the handle afterwards gives Error::ClientSuspended rather than Error::ObjectGone , so a caller can tell this from a client that left.

0 declared, 0 inherited

Esc

Type to search.