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

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§

source§

impl<T: Eq> Binding<T>

source

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

source

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

Trait Implementations§

source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where D: Deserializer<'a>,

Deserialize this value from the given Serde deserializer. Read more
source§

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

source§

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where D: Deserializer<'a>,

Deserialize this value from the given Serde deserializer. Read more
source§

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

source§

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

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

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.
source§

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

source§

impl<T> StructuralEq for Binding<T>

source§

impl<T> StructuralPartialEq for Binding<T>

Auto Trait Implementations§

§

impl<T> !RefUnwindSafe for Binding<T>

§

impl<T> !Send for Binding<T>

§

impl<T> !Sync for Binding<T>

§

impl<T> Unpin for Binding<T>where T: Unpin,

§

impl<T> !UnwindSafe for Binding<T>

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> DeserializeOwned for Twhere T: for<'de> Deserialize<'de>,