Struct tmux_interface::commands::key_bindings::bind_key::BindKey

pub struct BindKey<'a> {
    pub root: bool,
    pub repeat: bool,
    pub note: Option<Cow<'a, str>>,
    pub key_table: Option<Cow<'a, str>>,
    pub arguments: Option<Cow<'a, str>>,
    pub key: Option<Cow<'a, str>>,
    pub command: Option<Cow<'a, str>>,
}

Structure binding key key to command

Manual

tmux 3.1:

bind-key [-nr] [-N note] [-T key-table] key command [arguments]
(alias: bind)

tmux ^2.4:

bind-key [-nr] [-T key-table] key command [arguments]
(alias: bind)

tmux ^2.3:

bind-key [-cnr] [-R repeat-count] [-t mode-table] [-T key-table] key command [arguments]
(alias: bind)

tmux ^2.1:

bind-key [-cnr] [-t mode-table] [-T key-table] key command [arguments]
(alias: bind)

tmux ^2.0:

bind-key [-cnr] [-t mode-table] key command [arguments]
(alias: bind)

tmux ^1.0:

bind-key [-cnr] [-t key-table] key command [arguments]
(alias: bind)

tmux ^0.8:

bind-key [-r] key command [arguments]
(alias: bind)

Fields

root: bool

[-n] - an alias for -T root

repeat: bool

[-r] - this key may repeat

note: Option<Cow<'a, str>>

[-N note] - attaches note to the key

key_table: Option<Cow<'a, str>>

[-T key-table] - key-table

arguments: Option<Cow<'a, str>>

[arguments] - arguments

key: Option<Cow<'a, str>>

key

command: Option<Cow<'a, str>>

command

Implementations

impl<'a> BindKey<'a>

pub fn new() -> Self

pub fn root(self) -> Self

[-n] - an alias for -T root

pub fn repeat(self) -> Self

[-r] - this key may repeat

pub fn note<S: Into<Cow<'a, str>>>(self, note: S) -> Self

[-N note] - attaches note to the key

pub fn key_table<S: Into<Cow<'a, str>>>(self, key_table: S) -> Self

[-T key-table] - key-table

pub fn arguments<S: Into<Cow<'a, str>>>(self, key_table: S) -> Self

[arguments] - arguments

pub fn key<S: Into<Cow<'a, str>>>(self, key: S) -> Self

key

pub fn command<S: Into<Cow<'a, str>>>(self, command: S) -> Self

command

pub fn build(self) -> TmuxCommand<'a>

Trait Implementations

impl<'a> Clone for BindKey<'a>

fn clone(&self) -> BindKey<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for BindKey<'a>

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

Formats the value using the given formatter.

impl<'a> Default for BindKey<'a>

fn default() -> BindKey<'a>

Returns the “default value” for a type.

impl<'a> From<BindKey<'a>> for TmuxCommand<'a>

fn from(item: BindKey<'a>) -> Self

Converts to this type from the input type.

impl<'a> Hash for BindKey<'a>

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<'a> Ord for BindKey<'a>

fn cmp(&self, other: &BindKey<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<'a> PartialEq for BindKey<'a>

fn eq(&self, other: &BindKey<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialOrd for BindKey<'a>

fn partial_cmp(&self, other: &BindKey<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Eq for BindKey<'a>

impl<'a> StructuralPartialEq for BindKey<'a>