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.

method libtmux-rs latest

Session.detach_clients

Detach every client attached to this session.

Source and package
Qualified name
libtmux::session::Session::detach_clients
Module
session
Declared in
Session
Package
libtmux
Source
crates/libtmux/src/session.rs
Other languages
Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby Lua TypeScriptGoJavaC#C++Swift Kotlin Scala OCaml F# Clojure
pub async fn detach_clients(&self) -> Result<(), Error>

Description#

Succeeds when no client was attached. tmux reports that as a failure, but the state this asks for -- nobody attached to this session -- is already true, and a caller that has to tell "detached them" from "there was nobody" can compare crate::Server::clients() before and after.

Errors

Returns an error when tmux cannot be reached or refuses the detach for any other reason.

Examples#

let guard = libtmux::test::TestServer::new().await?;
let session = guard.server().new_session("busy").await?;
// Nothing is attached in a headless fixture, so this is a no-op.
session.detach_clients().await?;
guard.shutdown().await?;

tmux command#

The tmux commands behind detach_clients.

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

Detach every client attached to a session

Equivalents of Detach every client attached to a session in other languages
Language Equivalent
Python libtmux.Session.detach_client
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript session.Session.detach
Go tmux.Session.DetachClients
Java io.github.libtmux.Session.detachClients
C# LibTmux.Session.DetachClientAsync
C++ libtmux::Session::detach_clients
Swift Server.detachClients(from:)
OCaml No direct public OCaml equivalent is recorded for this operation.
Perl No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands.

No equivalent is recorded in Ruby, Lua, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.

Esc

Type to search.

Reference previewOpen reference