Struct KeyWithModifier

pub struct KeyWithModifier {
    pub bare_key: BareKey,
    pub key_modifiers: BTreeSet<KeyModifier>,
}

Fields

bare_key: BareKey

key_modifiers: BTreeSet<KeyModifier>

Implementations

impl KeyWithModifier

pub fn new(bare_key: BareKey) -> Self

pub fn new_with_modifiers( bare_key: BareKey, key_modifiers: BTreeSet<KeyModifier>, ) -> Self

pub fn with_shift_modifier(self) -> Self

pub fn with_alt_modifier(self) -> Self

pub fn with_ctrl_modifier(self) -> Self

pub fn with_super_modifier(self) -> Self

pub fn from_bytes_with_u( number_bytes: &[u8], modifier_bytes: &[u8], ) -> Option<Self>

pub fn from_bytes_with_tilde( number_bytes: &[u8], modifier_bytes: &[u8], ) -> Option<Self>

pub fn from_bytes_with_no_ending_byte( number_bytes: &[u8], modifier_bytes: &[u8], ) -> Option<Self>

pub fn strip_common_modifiers( &self, common_modifiers: &Vec<KeyModifier>, ) -> Self

pub fn is_key_without_modifier(&self, key: BareKey) -> bool

pub fn is_key_with_ctrl_modifier(&self, key: BareKey) -> bool

pub fn is_key_with_alt_modifier(&self, key: BareKey) -> bool

pub fn is_key_with_shift_modifier(&self, key: BareKey) -> bool

pub fn is_key_with_super_modifier(&self, key: BareKey) -> bool

pub fn is_cancel_key(&self) -> bool

pub fn to_termwiz_modifiers(&self) -> Modifiers

pub fn to_termwiz_keycode(&self) -> KeyCode

pub fn serialize_non_kitty(&self) -> Option<String>

pub fn serialize_kitty(&self) -> Option<String>

pub fn has_no_modifiers(&self) -> bool

pub fn has_modifiers(&self, modifiers: &[KeyModifier]) -> bool

impl KeyWithModifier

pub fn to_kdl(&self) -> String

Trait Implementations

impl Clone for KeyWithModifier

fn clone(&self) -> KeyWithModifier

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyWithModifier

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyWithModifier

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for KeyWithModifier

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

Formats the value using the given formatter.

impl FromStr for KeyWithModifier

type Err = Box<dyn Error>

The associated error which can be returned from parsing.

fn from_str(key_str: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for KeyWithModifier

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 Ord for KeyWithModifier

fn cmp(&self, other: &KeyWithModifier) -> 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,

Restrict a value to a certain interval.

impl PartialEq for KeyWithModifier

fn eq(&self, other: &Self) -> 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 PartialOrd for KeyWithModifier

fn partial_cmp(&self, other: &KeyWithModifier) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for KeyWithModifier

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Key> for KeyWithModifier

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(protobuf_key: ProtobufKey) -> Result<Self, &'static str>

Performs the conversion.

impl TryFrom<KeyWithModifier> for ProtobufKey

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(key_with_modifier: KeyWithModifier) -> Result<Self, &'static str>

Performs the conversion.

impl Eq for KeyWithModifier