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

Server.lock_all

Lock every client on the server.

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

Description#

Runs each client's lock-command, which is lock -np unless the server was told otherwise. Succeeds when nobody is attached, having locked nobody. crate::Session::lock() narrows this to one session and crate::Client::lock() to one client.

Errors

Returns an error when tmux refuses the command.

tmux command#

The tmux commands behind lock_all.

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

Lock every client attached to the server

Equivalents of Lock every client attached to the server in other languages
Language Equivalent
Python libtmux.Server.lock_server
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript no equivalent on Server
Go tmux.Server.LockServer
Java io.github.libtmux.Server.lock
C# LibTmux.Server.LockAsync
C++ no equivalent on Server
Swift no equivalent on 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#.

Esc

Type to search.

Reference previewOpen reference