Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

options.OptionKind

Rust
  • Python Unavailable
  • TypeScript Unavailable
  • Rust
  • Go Unavailable
  • Java Unavailable
  • .NET Unavailable
  • C++ Unavailable
  • Swift Unavailable

View as Markdown

Module
options
Package
libtmux
Source
crates/libtmux/src/options.rs
enum options.OptionKind
enum [source]
enum [source]
enum options.OptionKind

What kind of value an option holds.

Examples

use libtmux::{OptionKind, option_schema};
// `mouse` is a real flag: on or off.
assert_eq!(option_schema("mouse").map(OptionSchema::kind), Some(OptionKind::Flag));
// `status` looks like one and is not: it also accepts a count of status
// lines, so reading it as a boolean discards those values.
assert_eq!(option_schema("status").map(OptionSchema::kind), Some(OptionKind::Choice));

7 declared, 0 inherited

Members

  • Choice constant One of a fixed set of words.
  • Colour constant A terminal colour.
  • Command constant A tmux command.
  • Flag constant on or off.
  • Key constant A key name.
  • Number constant An integer.
  • Text constant Arbitrary text.
Esc

Type to search.