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

Session.option_names

List the option names set at this session's scope.

Source and package
Qualified name
libtmux::session::Session::option_names
Module
session
Declared in
Session
Package
libtmux
Source
crates/libtmux/src/session/settings.rs
pub async fn option_names(&self) -> Result< Vec<String>, Error >

Description#

Values are not included: tmux renders them for display with three different quoting styles, so re-parsing them would be guesswork. Read each value with Self::typed_option(), which decodes the exact bytes.

Names are String, not TmuxText, because tmux's own are ASCII and every option method takes one as &str; a user option (@name) lists cut at any whitespace in its name, and with U+FFFD for bytes that are not UTF-8, since show-options prints names unframed.

Errors

Returns an error when tmux refuses the listing.

tmux command#

The tmux commands behind option_names.

tmux C API#

The C declarations in tmux that implement these commands.

Esc

Type to search.

Reference previewOpen reference