Struct Binding

pub struct Binding<T> {
    pub mods: ModifiersState,
    pub action: Action,
    pub mode: BindingMode,
    pub notmode: BindingMode,
    pub trigger: T,
}

Describes a state and action to take in that state.

This is the shared component of MouseBinding and KeyBinding.

Fields

mods: ModifiersState

Modifier keys required to activate binding.

action: Action

String to send to PTY if mods and mode match.

mode: BindingMode

Binding mode required to activate binding.

notmode: BindingMode

Excluded binding modes where the binding won’t be activated.

trigger: T

This property is used as part of the trigger detection code.

For example, this might be a key like “G”, or a mouse button.

Implementations

impl<T: Eq> Binding<T>

pub fn is_triggered_by( &self, mode: BindingMode, mods: ModifiersState, input: &T, ) -> bool

pub fn triggers_match(&self, binding: &Binding<T>) -> bool

Trait Implementations

impl<T: Clone> Clone for Binding<T>

fn clone(&self) -> Binding<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Binding<T>

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

Formats the value using the given formatter.

impl<'a> Deserialize<'a> for Binding<BindingKey>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'a>,

Deserialize this value from the given Serde deserializer.

impl<'a> Deserialize<'a> for Binding<MouseButton>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'a>,

Deserialize this value from the given Serde deserializer.

impl<T: PartialEq> PartialEq for Binding<T>

fn eq(&self, other: &Binding<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T: Eq> Eq for Binding<T>

impl<T> StructuralPartialEq for Binding<T>