Struct mortal::terminal::ModifierState
[−]
pub struct ModifierState { /* fields omitted */ }
Represents a set of modifier keys
Methods
impl ModifierState
pub const ALT: ModifierState
ALT: ModifierState = ModifierState{bits: 1 << 0,}
Alt key
pub const CTRL: ModifierState
CTRL: ModifierState = ModifierState{bits: 1 << 1,}
Ctrl key
pub const SHIFT: ModifierState
SHIFT: ModifierState = ModifierState{bits: 1 << 2,}
Shift key
pub fn empty() -> ModifierState
Returns an empty set of flags.
pub fn all() -> ModifierState
Returns the set containing all flags.
pub fn bits(&self) -> u8
Returns the raw value of the flags currently stored.
pub fn from_bits(bits: u8) -> Option<ModifierState>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
pub fn from_bits_truncate(bits: u8) -> ModifierState
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
pub fn is_empty(&self) -> bool
Returns true
if no flags are currently stored.
pub fn is_all(&self) -> bool
Returns true
if all flags are currently set.
pub fn intersects(&self, other: ModifierState) -> bool
Returns true
if there are flags common to both self
and other
.
pub fn contains(&self, other: ModifierState) -> bool
Returns true
all of the flags in other
are contained within self
.
pub fn insert(&mut self, other: ModifierState)
Inserts the specified flags in-place.
pub fn remove(&mut self, other: ModifierState)
Removes the specified flags in-place.
pub fn toggle(&mut self, other: ModifierState)
Toggles the specified flags in-place.
pub fn set(&mut self, other: ModifierState, value: bool)
Inserts or removes the specified flags depending on the passed value.
Trait Implementations
impl Copy for ModifierState
impl PartialEq for ModifierState
fn eq(&self, __arg_0: &ModifierState) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &ModifierState) -> bool
This method tests for !=
.
impl Eq for ModifierState
impl Clone for ModifierState
fn clone(&self) -> ModifierState
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl PartialOrd for ModifierState
fn partial_cmp(&self, __arg_0: &ModifierState) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, __arg_0: &ModifierState) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, __arg_0: &ModifierState) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, __arg_0: &ModifierState) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, __arg_0: &ModifierState) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl Ord for ModifierState
fn cmp(&self, __arg_0: &ModifierState) -> Ordering
This method returns an Ordering
between self
and other
. Read more
fn max(self, other: Self) -> Self
1.21.0[src]
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
1.21.0[src]
Compares and returns the minimum of two values. Read more
impl Hash for ModifierState
fn hash<__H: Hasher>(&self, __arg_0: &mut __H)
Feeds this value into the given [Hasher
]. Read more
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
Feeds a slice of this type into the given [Hasher
]. Read more
impl Debug for ModifierState
impl Binary for ModifierState
impl Octal for ModifierState
impl LowerHex for ModifierState
impl UpperHex for ModifierState
impl BitOr for ModifierState
type Output = ModifierState
The resulting type after applying the |
operator.
fn bitor(self, other: ModifierState) -> ModifierState
Returns the union of the two sets of flags.
impl BitOrAssign for ModifierState
fn bitor_assign(&mut self, other: ModifierState)
Adds the set of flags.
impl BitXor for ModifierState
type Output = ModifierState
The resulting type after applying the ^
operator.
fn bitxor(self, other: ModifierState) -> ModifierState
Returns the left flags, but with all the right flags toggled.
impl BitXorAssign for ModifierState
fn bitxor_assign(&mut self, other: ModifierState)
Toggles the set of flags.
impl BitAnd for ModifierState
type Output = ModifierState
The resulting type after applying the &
operator.
fn bitand(self, other: ModifierState) -> ModifierState
Returns the intersection between the two sets of flags.
impl BitAndAssign for ModifierState
fn bitand_assign(&mut self, other: ModifierState)
Disables all flags disabled in the set.
impl Sub for ModifierState
type Output = ModifierState
The resulting type after applying the -
operator.
fn sub(self, other: ModifierState) -> ModifierState
Returns the set difference of the two sets of flags.
impl SubAssign for ModifierState
fn sub_assign(&mut self, other: ModifierState)
Disables all flags enabled in the set.
impl Not for ModifierState
type Output = ModifierState
The resulting type after applying the !
operator.
fn not(self) -> ModifierState
Returns the complement of this set of flags.
impl Extend<ModifierState> for ModifierState
fn extend<T: IntoIterator<Item = ModifierState>>(&mut self, iterator: T)
Extends a collection with the contents of an iterator. Read more
impl FromIterator<ModifierState> for ModifierState
fn from_iter<T: IntoIterator<Item = ModifierState>>(
iterator: T
) -> ModifierState
iterator: T
) -> ModifierState
Creates a value from an iterator. Read more