[−]Struct terminal::KeyModifiers
Represents key modifiers (shift, control, alt).
Methods
impl KeyModifiers
pub const SHIFT: KeyModifiers
pub const CONTROL: KeyModifiers
pub const ALT: KeyModifiers
pub const fn empty() -> KeyModifiers
Returns an empty set of flags
pub const fn all() -> KeyModifiers
Returns the set containing all flags.
pub const fn bits(&self) -> u8
Returns the raw value of the flags currently stored.
pub fn from_bits(bits: u8) -> Option<KeyModifiers>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
pub const fn from_bits_truncate(bits: u8) -> KeyModifiers
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
pub const unsafe fn from_bits_unchecked(bits: u8) -> KeyModifiers
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
pub const fn is_empty(&self) -> bool
Returns true
if no flags are currently stored.
pub const fn is_all(&self) -> bool
Returns true
if all flags are currently set.
pub const fn intersects(&self, other: KeyModifiers) -> bool
Returns true
if there are flags common to both self
and other
.
pub const fn contains(&self, other: KeyModifiers) -> bool
Returns true
all of the flags in other
are contained within self
.
pub fn insert(&mut self, other: KeyModifiers)
Inserts the specified flags in-place.
pub fn remove(&mut self, other: KeyModifiers)
Removes the specified flags in-place.
pub fn toggle(&mut self, other: KeyModifiers)
Toggles the specified flags in-place.
pub fn set(&mut self, other: KeyModifiers, value: bool)
Inserts or removes the specified flags depending on the passed value.
Trait Implementations
impl Binary for KeyModifiers
impl BitAnd<KeyModifiers> for KeyModifiers
type Output = KeyModifiers
The resulting type after applying the &
operator.
fn bitand(self, other: KeyModifiers) -> KeyModifiers
Returns the intersection between the two sets of flags.
impl BitAndAssign<KeyModifiers> for KeyModifiers
fn bitand_assign(&mut self, other: KeyModifiers)
Disables all flags disabled in the set.
impl BitOr<KeyModifiers> for KeyModifiers
type Output = KeyModifiers
The resulting type after applying the |
operator.
fn bitor(self, other: KeyModifiers) -> KeyModifiers
Returns the union of the two sets of flags.
impl BitOrAssign<KeyModifiers> for KeyModifiers
fn bitor_assign(&mut self, other: KeyModifiers)
Adds the set of flags.
impl BitXor<KeyModifiers> for KeyModifiers
type Output = KeyModifiers
The resulting type after applying the ^
operator.
fn bitxor(self, other: KeyModifiers) -> KeyModifiers
Returns the left flags, but with all the right flags toggled.
impl BitXorAssign<KeyModifiers> for KeyModifiers
fn bitxor_assign(&mut self, other: KeyModifiers)
Toggles the set of flags.
impl Clone for KeyModifiers
fn clone(&self) -> KeyModifiers
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Copy for KeyModifiers
impl Debug for KeyModifiers
impl Eq for KeyModifiers
impl Extend<KeyModifiers> for KeyModifiers
fn extend<T: IntoIterator<Item = KeyModifiers>>(&mut self, iterator: T)
impl From<KeyModifiers> for KeyModifiers
[src]
fn from(modifiers: KeyModifiers) -> Self
[src]
impl FromIterator<KeyModifiers> for KeyModifiers
fn from_iter<T: IntoIterator<Item = KeyModifiers>>(iterator: T) -> KeyModifiers
impl Hash for KeyModifiers
fn hash<__H: Hasher>(&self, state: &mut __H)
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl LowerHex for KeyModifiers
impl Not for KeyModifiers
type Output = KeyModifiers
The resulting type after applying the !
operator.
fn not(self) -> KeyModifiers
Returns the complement of this set of flags.
impl Octal for KeyModifiers
impl Ord for KeyModifiers
fn cmp(&self, other: &KeyModifiers) -> Ordering
fn max(self, other: Self) -> Self
1.21.0[src]
fn min(self, other: Self) -> Self
1.21.0[src]
fn clamp(self, min: Self, max: Self) -> Self
[src]
impl PartialEq<KeyModifiers> for KeyModifiers
fn eq(&self, other: &KeyModifiers) -> bool
fn ne(&self, other: &KeyModifiers) -> bool
impl PartialOrd<KeyModifiers> for KeyModifiers
fn partial_cmp(&self, other: &KeyModifiers) -> Option<Ordering>
fn lt(&self, other: &KeyModifiers) -> bool
fn le(&self, other: &KeyModifiers) -> bool
fn gt(&self, other: &KeyModifiers) -> bool
fn ge(&self, other: &KeyModifiers) -> bool
impl StructuralEq for KeyModifiers
impl StructuralPartialEq for KeyModifiers
impl Sub<KeyModifiers> for KeyModifiers
type Output = KeyModifiers
The resulting type after applying the -
operator.
fn sub(self, other: KeyModifiers) -> KeyModifiers
Returns the set difference of the two sets of flags.
impl SubAssign<KeyModifiers> for KeyModifiers
fn sub_assign(&mut self, other: KeyModifiers)
Disables all flags enabled in the set.
impl UpperHex for KeyModifiers
Auto Trait Implementations
impl RefUnwindSafe for KeyModifiers
impl Send for KeyModifiers
impl Sync for KeyModifiers
impl Unpin for KeyModifiers
impl UnwindSafe for KeyModifiers
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,