Struct KeyBinding 

pub struct KeyBinding { /* private fields */ }

One key binding, as tmux holds it.

bind-key -n is -T root, so Self::table answers it. The command is the text a bind-key line in a configuration file carries, with \; between commands, and is not parsed further. That is argument syntax: as the single command string Server::bind_key takes, \; is a literal semicolon rather than a separator.

Examples

let guard = libtmux::test::TestServer::new().await?;
let server = guard.server();
server.bind_key("prefix", "Y", "display-message hello").await?;

let version = server.capabilities().await?.tmux_version().clone();
if version.has_behavior(&libtmux::since::LIST_KEYS_FORMAT) {
    let bindings = server.typed_key_bindings(Some("prefix")).await?;
    let bound = bindings
        .iter()
        .find(|binding| binding.key() == "Y")
        .ok_or("the binding is listed")?;
    assert_eq!(bound.command(), "display-message hello");
    assert!(!bound.repeats());
    assert_eq!(bound.note(), None);
}

guard.shutdown().await?;

Implementations

impl KeyBinding

pub const fn table(&self) -> &TmuxText

Return the key table, such as prefix, root or copy-mode-vi.

pub const fn key(&self) -> &TmuxText

Return the key as tmux names it, such as C-b or ", unquoted.

pub const fn command(&self) -> &TmuxText

Return the bound command list, as a bind-key line renders it.

pub const fn note(&self) -> Option<&TmuxText>

Return the note bind-key -N attached, if any.

An empty note reads as none: tmux reports both as an empty value.

pub const fn repeats(&self) -> bool

Report whether the binding repeats, bind-key -r.

Trait Implementations

impl Clone for KeyBinding

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for KeyBinding

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for KeyBinding

impl Hash for KeyBinding

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for KeyBinding

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for KeyBinding