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.cmd

Execute one raw logical tmux command.

Source and package
Qualified name
libtmux::server::Server::cmd
Module
server
Declared in
Server
Package
libtmux
Source
crates/libtmux/src/server.rs
Other languages
Perlmethod Erlangfunction PowerShell Julia Elixirfunction Haskell Common Lisp PythonRubyLuaTypeScriptGoJava C# C++ Swift Kotlin Scala OCaml F# Clojure
pub async fn cmd(&self, command: Command) -> Result< CommandResult, Error >

Description#

A non-zero process exit status is returned in CommandResult. The connected daemon must meet TmuxVersion::MIN_SUPPORTED; a cold endpoint checks the executable that would start it. A queue guard refuses a replacement with a different version before effects. Standalone -V and -h retain native executable diagnostics below the floor; an open control connection cannot represent those client flags.

Errors

Returns an error when the process cannot be started, captured, awaited, or is cancelled by timeout or shutdown. Invalid or unsupported daemon versions and failed version probes are errors before dispatch.

Examples#

let server = libtmux::Server::builder()
.socket_path("/tmp/libtmux-rs-test/command-example-absent.sock")
.build()?;
let result = server.cmd(libtmux::Command::new("list-sessions")).await?;
assert!(result.exit_code().is_some());
server.shutdown().await?;
Parameters

Guides#

Pages that discuss cmd.

In other ports#

Run a tmux command this port does not model

Equivalents of Run a tmux command this port does not model in other languages
Language Equivalent
Python libtmux.Server.cmd
Ruby LibTmux::Server#run
Lua libtmux.Server:command
Erlang tmux_server:command/3 Executes an explicit command value with bounded output and separate outcome and cleanup evidence.
Elixir LibTmux.Server.run/3 Runs one trusted Command without attaching a client and returns bounded output with exit evidence.
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript server.Server.cmd
Go tmux.Server.Cmd
Java io.github.libtmux.Server.cmd
C# no equivalent on Server
C++ no equivalent on Server
Swift no equivalent on Server
OCaml No direct public OCaml equivalent is recorded for this operation.
Perl LibTmux::Server::cmd Checked literal argument vector; no shell wrapper or implicit tmux command list.

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

Esc

Type to search.

Reference previewOpen reference