Struct KeyModifiers 

pub struct KeyModifiers { /* private fields */ }

Modifier flags that may accompany an SDK KeyEvent.

The bitfield mirrors the modifiers that survive tmux-compatible attach translation (Shift, Control, Alt, Super, Hyper, Meta) without adopting any single host library’s encoding. Unknown bits are rejected at construction time so deserialized values cannot smuggle reserved bits through the SDK boundary.

Implementations

impl KeyModifiers

pub const NONE: Self

No modifiers held.

pub const SHIFT: Self

Shift modifier flag.

pub const CONTROL: Self

Control modifier flag.

pub const ALT: Self

Alt (Option on macOS) modifier flag.

pub const SUPER: Self

Super (Command/Windows) modifier flag.

pub const HYPER: Self

Hyper modifier flag.

pub const META: Self

Meta modifier flag.

pub const fn empty() -> Self

Returns the empty modifier set.

pub const fn bits(self) -> u8

Returns the raw bitfield representation.

pub const fn from_bits(bits: u8) -> Option<Self>

Constructs modifiers from a bitfield, rejecting reserved bits.

pub const fn from_bits_truncate(bits: u8) -> Self

Constructs modifiers from a bitfield, dropping any reserved bits.

pub const fn is_empty(self) -> bool

Returns true when this set is empty.

pub const fn contains(self, other: Self) -> bool

Returns true when every bit in other is also set in self.

pub const fn union(self, other: Self) -> Self

Returns the union of self and other.

pub const fn intersection(self, other: Self) -> Self

Returns the intersection of self and other.

pub const fn symmetric_difference(self, other: Self) -> Self

Returns the symmetric difference of self and other.

Trait Implementations

impl BitAnd for KeyModifiers

type Output = KeyModifiers

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self

Performs the & operation.

impl BitOr for KeyModifiers

type Output = KeyModifiers

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self

Performs the | operation.

impl BitXor for KeyModifiers

type Output = KeyModifiers

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self

Performs the ^ operation.

impl Clone for KeyModifiers

fn clone(&self) -> KeyModifiers

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for KeyModifiers

impl Debug for KeyModifiers

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

Formats the value using the given formatter.

impl Default for KeyModifiers

fn default() -> KeyModifiers

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for KeyModifiers

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for KeyModifiers

impl Hash for KeyModifiers

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 KeyModifiers

fn eq(&self, other: &KeyModifiers) -> 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 Serialize for KeyModifiers

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for KeyModifiers