Session.detach_clients
Detach every client attached to this session.
Source and package
-
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
| Language | Equivalent |
|---|---|
| Python | libtmux |
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| TypeScript | session |
| Go | tmux |
| Java | io |
| C# | Lib |
| C++ | libtmux:: |
| Swift | Server |
| 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#.