Struct tcod::input::KeyPressFlags
[−]
pub struct KeyPressFlags { /* fields omitted */ }
Methods
impl KeyPressFlags
fn empty() -> KeyPressFlags
Returns an empty set of flags.
fn all() -> KeyPressFlags
Returns the set containing all flags.
fn bits(&self) -> c_uint
Returns the raw value of the flags currently stored.
fn from_bits(bits: c_uint) -> Option<KeyPressFlags>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
fn from_bits_truncate(bits: c_uint) -> KeyPressFlags
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
fn is_empty(&self) -> bool
Returns true
if no flags are currently stored.
fn is_all(&self) -> bool
Returns true
if all flags are currently set.
fn intersects(&self, other: KeyPressFlags) -> bool
Returns true
if there are flags common to both self
and other
.
fn contains(&self, other: KeyPressFlags) -> bool
Returns true
all of the flags in other
are contained within self
.
fn insert(&mut self, other: KeyPressFlags)
Inserts the specified flags in-place.
fn remove(&mut self, other: KeyPressFlags)
Removes the specified flags in-place.
fn toggle(&mut self, other: KeyPressFlags)
Toggles the specified flags in-place.
Trait Implementations
impl Copy for KeyPressFlags
impl PartialEq for KeyPressFlags
fn eq(&self, __arg_0: &KeyPressFlags) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &KeyPressFlags) -> bool
This method tests for !=
.
impl Eq for KeyPressFlags
impl Clone for KeyPressFlags
fn clone(&self) -> KeyPressFlags
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0
Performs copy-assignment from source
. Read more
impl PartialOrd for KeyPressFlags
fn partial_cmp(&self, __arg_0: &KeyPressFlags) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, __arg_0: &KeyPressFlags) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, __arg_0: &KeyPressFlags) -> 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: &KeyPressFlags) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, __arg_0: &KeyPressFlags) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl Ord for KeyPressFlags
fn cmp(&self, __arg_0: &KeyPressFlags) -> Ordering
This method returns an Ordering
between self
and other
. Read more
impl Hash for KeyPressFlags
fn hash<__H: Hasher>(&self, __arg_0: &mut __H)
Feeds this value into the state given, updating the hasher as necessary.
fn hash_slice<H>(data: &[Self], state: &mut H) where H: Hasher
1.3.0
Feeds a slice of this type into the state provided.
impl BitOr for KeyPressFlags
type Output = KeyPressFlags
The resulting type after applying the |
operator
fn bitor(self, other: KeyPressFlags) -> KeyPressFlags
Returns the union of the two sets of flags.
impl BitXor for KeyPressFlags
type Output = KeyPressFlags
The resulting type after applying the ^
operator
fn bitxor(self, other: KeyPressFlags) -> KeyPressFlags
Returns the left flags, but with all the right flags toggled.
impl BitAnd for KeyPressFlags
type Output = KeyPressFlags
The resulting type after applying the &
operator
fn bitand(self, other: KeyPressFlags) -> KeyPressFlags
Returns the intersection between the two sets of flags.
impl Sub for KeyPressFlags
type Output = KeyPressFlags
The resulting type after applying the -
operator
fn sub(self, other: KeyPressFlags) -> KeyPressFlags
Returns the set difference of the two sets of flags.
impl Not for KeyPressFlags
type Output = KeyPressFlags
The resulting type after applying the !
operator
fn not(self) -> KeyPressFlags
Returns the complement of this set of flags.