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

CommandChain.summary

Build a bounded, sanitized summary of the whole chain.

Source and package
Qualified name
libtmux::command::CommandChain::summary
Module
command
Declared in
CommandChain
Package
libtmux
Source
crates/libtmux/src/command.rs
#[must_use] pub fn summary(&self) -> CommandSummary

Description#

Separators render bare and are counted as neither public nor sensitive arguments. Every other token of every member, including the subcommands after the first, counts as an argument of the summary.

Examples#

use libtmux::{Command, CommandChain};
let summary = CommandChain::new(Command::new("select-pane").arg("-m"))
.then(Command::new("select-pane").arg("-M"))
.summary();
assert_eq!(summary.to_string(), r#""select-pane" "-m" ; "select-pane" "-M""#);
assert_eq!(summary.public_argument_count(), 3);
Esc

Type to search.

Reference previewOpen reference