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.

struct libtmux-rs latest

Command

A logical tmux command with classified diagnostic arguments.

Source and package
Qualified name
libtmux::command::Command
Module
command
Package
libtmux
Source
crates/libtmux/src/command.rs
struct command.Command

Description#

Commands retain operating-system strings so dispatch can preserve arbitrary Unix bytes. Use Command::summary() for a bounded, sanitized diagnostic representation.

Examples#

use libtmux::Command;
let command = Command::new("display-message").arg("hello");
assert_eq!(command.summary().argument_count(), 1);

Members5#

  • arg method Append one public logical argument.
  • new method Start a command with one logical tmux subcommand token.
  • requires_tmux method Require a daemon release before dispatching this command.
  • sensitive_arg method Append one sensitive logical argument.
  • summary method Build a bounded, sanitized summary of the logical command.
Esc

Type to search.

Reference previewOpen reference