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

formats.text.TmuxText.as_flag

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

View as Markdown

Module
formats.text
Declared in
TmuxText
Package
libtmux
Source
crates/libtmux/src/formats/text.rs
as_flag ( self ) → Option<bool>
method [source]
method [source]
as_flag

Interpret these bytes as a tmux flag.

tmux writes flags as on and off, and accepts yes and no for some. Anything else returns None rather than guessing, because an option holding arbitrary text is not a flag.

Examples

use libtmux::TmuxText;
assert_eq!(TmuxText::from("on").as_flag(), Some(true));
assert_eq!(TmuxText::from("off").as_flag(), Some(false));
assert_eq!(TmuxText::from("sometimes").as_flag(), None);

0 declared, 0 inherited

Esc

Type to search.