Struct kernel_hal::drivers::prelude::input::MouseFlags
source · [−]pub struct MouseFlags { /* private fields */ }
Implementations
sourceimpl MouseFlags
impl MouseFlags
sourcepub const LEFT_BTN: MouseFlags = Self{bits: 1 << 0,}
pub const LEFT_BTN: MouseFlags = Self{bits: 1 << 0,}
Whether or not the left mouse button is pressed.
sourcepub const RIGHT_BTN: MouseFlags = Self{bits: 1 << 1,}
pub const RIGHT_BTN: MouseFlags = Self{bits: 1 << 1,}
Whether or not the right mouse button is pressed.
sourcepub const MIDDLE_BTN: MouseFlags = Self{bits: 1 << 2,}
pub const MIDDLE_BTN: MouseFlags = Self{bits: 1 << 2,}
Whether or not the middle mouse button is pressed.
sourcepub const ALWAYS_ONE: MouseFlags = Self{bits: 1 << 3,}
pub const ALWAYS_ONE: MouseFlags = Self{bits: 1 << 3,}
Whether or not the packet is valid or not.
sourcepub const X_SIGN: MouseFlags = Self{bits: 1 << 4,}
pub const X_SIGN: MouseFlags = Self{bits: 1 << 4,}
Whether or not the x delta is negative.
sourcepub const Y_SIGN: MouseFlags = Self{bits: 1 << 5,}
pub const Y_SIGN: MouseFlags = Self{bits: 1 << 5,}
Whether or not the y delta is negative.
sourcepub const fn empty() -> MouseFlags
pub const fn empty() -> MouseFlags
Returns an empty set of flags.
sourcepub const fn all() -> MouseFlags
pub const fn all() -> MouseFlags
Returns the set containing all flags.
sourcepub const fn from_bits(bits: u8) -> Option<MouseFlags>
pub const fn from_bits(bits: u8) -> Option<MouseFlags>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u8) -> MouseFlags
pub const fn from_bits_truncate(bits: u8) -> MouseFlags
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u8) -> MouseFlags
pub const unsafe fn from_bits_unchecked(bits: u8) -> MouseFlags
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
sourcepub const fn intersects(&self, other: MouseFlags) -> bool
pub const fn intersects(&self, other: MouseFlags) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: MouseFlags) -> bool
pub const fn contains(&self, other: MouseFlags) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn insert(&mut self, other: MouseFlags)
pub fn insert(&mut self, other: MouseFlags)
Inserts the specified flags in-place.
sourcepub fn remove(&mut self, other: MouseFlags)
pub fn remove(&mut self, other: MouseFlags)
Removes the specified flags in-place.
sourcepub fn toggle(&mut self, other: MouseFlags)
pub fn toggle(&mut self, other: MouseFlags)
Toggles the specified flags in-place.
sourcepub fn set(&mut self, other: MouseFlags, value: bool)
pub fn set(&mut self, other: MouseFlags, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: MouseFlags) -> MouseFlags
pub const fn intersection(self, other: MouseFlags) -> MouseFlags
Returns the intersection between the flags in self
and
other
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
sourcepub const fn union(self, other: MouseFlags) -> MouseFlags
pub const fn union(self, other: MouseFlags) -> MouseFlags
Returns the union of between the flags in self
and other
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
sourcepub const fn difference(self, other: MouseFlags) -> MouseFlags
pub const fn difference(self, other: MouseFlags) -> MouseFlags
Returns the difference between the flags in self
and other
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
sourcepub const fn symmetric_difference(self, other: MouseFlags) -> MouseFlags
pub const fn symmetric_difference(self, other: MouseFlags) -> MouseFlags
Returns the symmetric difference between the flags
in self
and other
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
sourcepub const fn complement(self) -> MouseFlags
pub const fn complement(self) -> MouseFlags
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
Trait Implementations
sourceimpl Binary for MouseFlags
impl Binary for MouseFlags
sourceimpl BitAnd<MouseFlags> for MouseFlags
impl BitAnd<MouseFlags> for MouseFlags
sourcefn bitand(self, other: MouseFlags) -> MouseFlags
fn bitand(self, other: MouseFlags) -> MouseFlags
Returns the intersection between the two sets of flags.
type Output = MouseFlags
type Output = MouseFlags
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<MouseFlags> for MouseFlags
impl BitAndAssign<MouseFlags> for MouseFlags
sourcefn bitand_assign(&mut self, other: MouseFlags)
fn bitand_assign(&mut self, other: MouseFlags)
Disables all flags disabled in the set.
sourceimpl BitOr<MouseFlags> for MouseFlags
impl BitOr<MouseFlags> for MouseFlags
sourcefn bitor(self, other: MouseFlags) -> MouseFlags
fn bitor(self, other: MouseFlags) -> MouseFlags
Returns the union of the two sets of flags.
type Output = MouseFlags
type Output = MouseFlags
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<MouseFlags> for MouseFlags
impl BitOrAssign<MouseFlags> for MouseFlags
sourcefn bitor_assign(&mut self, other: MouseFlags)
fn bitor_assign(&mut self, other: MouseFlags)
Adds the set of flags.
sourceimpl BitXor<MouseFlags> for MouseFlags
impl BitXor<MouseFlags> for MouseFlags
sourcefn bitxor(self, other: MouseFlags) -> MouseFlags
fn bitxor(self, other: MouseFlags) -> MouseFlags
Returns the left flags, but with all the right flags toggled.
type Output = MouseFlags
type Output = MouseFlags
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<MouseFlags> for MouseFlags
impl BitXorAssign<MouseFlags> for MouseFlags
sourcefn bitxor_assign(&mut self, other: MouseFlags)
fn bitxor_assign(&mut self, other: MouseFlags)
Toggles the set of flags.
sourceimpl Clone for MouseFlags
impl Clone for MouseFlags
sourcefn clone(&self) -> MouseFlags
fn clone(&self) -> MouseFlags
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for MouseFlags
impl Debug for MouseFlags
sourceimpl Default for MouseFlags
impl Default for MouseFlags
sourcefn default() -> MouseFlags
fn default() -> MouseFlags
Returns the “default value” for a type. Read more
sourceimpl Extend<MouseFlags> for MouseFlags
impl Extend<MouseFlags> for MouseFlags
sourcefn extend<T>(&mut self, iterator: T) where
T: IntoIterator<Item = MouseFlags>,
fn extend<T>(&mut self, iterator: T) where
T: IntoIterator<Item = MouseFlags>,
Extends a collection with the contents of an iterator. Read more
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Extends a collection with exactly one element.
sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
sourceimpl FromIterator<MouseFlags> for MouseFlags
impl FromIterator<MouseFlags> for MouseFlags
sourcefn from_iter<T>(iterator: T) -> MouseFlags where
T: IntoIterator<Item = MouseFlags>,
fn from_iter<T>(iterator: T) -> MouseFlags where
T: IntoIterator<Item = MouseFlags>,
Creates a value from an iterator. Read more
sourceimpl Hash for MouseFlags
impl Hash for MouseFlags
sourceimpl LowerHex for MouseFlags
impl LowerHex for MouseFlags
sourceimpl Not for MouseFlags
impl Not for MouseFlags
sourcefn not(self) -> MouseFlags
fn not(self) -> MouseFlags
Returns the complement of this set of flags.
type Output = MouseFlags
type Output = MouseFlags
The resulting type after applying the !
operator.
sourceimpl Octal for MouseFlags
impl Octal for MouseFlags
sourceimpl Ord for MouseFlags
impl Ord for MouseFlags
sourcefn cmp(&self, other: &MouseFlags) -> Ordering
fn cmp(&self, other: &MouseFlags) -> Ordering
1.21.0 · sourcefn max(self, other: Self) -> Self
fn max(self, other: Self) -> Self
Compares and returns the maximum of two values. Read more
1.21.0 · sourcefn min(self, other: Self) -> Self
fn min(self, other: Self) -> Self
Compares and returns the minimum of two values. Read more
1.50.0 · sourcefn clamp(self, min: Self, max: Self) -> Self where
Self: PartialOrd<Self>,
fn clamp(self, min: Self, max: Self) -> Self where
Self: PartialOrd<Self>,
Restrict a value to a certain interval. Read more
sourceimpl PartialEq<MouseFlags> for MouseFlags
impl PartialEq<MouseFlags> for MouseFlags
sourcefn eq(&self, other: &MouseFlags) -> bool
fn eq(&self, other: &MouseFlags) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &MouseFlags) -> bool
fn ne(&self, other: &MouseFlags) -> bool
This method tests for !=
.
sourceimpl PartialOrd<MouseFlags> for MouseFlags
impl PartialOrd<MouseFlags> for MouseFlags
sourcefn partial_cmp(&self, other: &MouseFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &MouseFlags) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl Sub<MouseFlags> for MouseFlags
impl Sub<MouseFlags> for MouseFlags
sourcefn sub(self, other: MouseFlags) -> MouseFlags
fn sub(self, other: MouseFlags) -> MouseFlags
Returns the set difference of the two sets of flags.
type Output = MouseFlags
type Output = MouseFlags
The resulting type after applying the -
operator.
sourceimpl SubAssign<MouseFlags> for MouseFlags
impl SubAssign<MouseFlags> for MouseFlags
sourcefn sub_assign(&mut self, other: MouseFlags)
fn sub_assign(&mut self, other: MouseFlags)
Disables all flags enabled in the set.
sourceimpl UpperHex for MouseFlags
impl UpperHex for MouseFlags
impl Copy for MouseFlags
impl Eq for MouseFlags
impl StructuralEq for MouseFlags
impl StructuralPartialEq for MouseFlags
Auto Trait Implementations
impl RefUnwindSafe for MouseFlags
impl Send for MouseFlags
impl Sync for MouseFlags
impl Unpin for MouseFlags
impl UnwindSafe for MouseFlags
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> CheckedAs for T
impl<T> CheckedAs for T
sourcefn checked_as<Dst>(self) -> Option<Dst> where
T: CheckedCast<Dst>,
fn checked_as<Dst>(self) -> Option<Dst> where
T: CheckedCast<Dst>,
Casts the value.
sourceimpl<Src, Dst> CheckedCastFrom<Src> for Dst where
Src: CheckedCast<Dst>,
impl<Src, Dst> CheckedCastFrom<Src> for Dst where
Src: CheckedCast<Dst>,
sourcefn checked_cast_from(src: Src) -> Option<Dst>
fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.
sourceimpl<T> OverflowingAs for T
impl<T> OverflowingAs for T
sourcefn overflowing_as<Dst>(self) -> (Dst, bool) where
T: OverflowingCast<Dst>,
fn overflowing_as<Dst>(self) -> (Dst, bool) where
T: OverflowingCast<Dst>,
Casts the value.
sourceimpl<Src, Dst> OverflowingCastFrom<Src> for Dst where
Src: OverflowingCast<Dst>,
impl<Src, Dst> OverflowingCastFrom<Src> for Dst where
Src: OverflowingCast<Dst>,
sourcefn overflowing_cast_from(src: Src) -> (Dst, bool)
fn overflowing_cast_from(src: Src) -> (Dst, bool)
Casts the value.
sourceimpl<T> SaturatingAs for T
impl<T> SaturatingAs for T
sourcefn saturating_as<Dst>(self) -> Dst where
T: SaturatingCast<Dst>,
fn saturating_as<Dst>(self) -> Dst where
T: SaturatingCast<Dst>,
Casts the value.
sourceimpl<Src, Dst> SaturatingCastFrom<Src> for Dst where
Src: SaturatingCast<Dst>,
impl<Src, Dst> SaturatingCastFrom<Src> for Dst where
Src: SaturatingCast<Dst>,
sourcefn saturating_cast_from(src: Src) -> Dst
fn saturating_cast_from(src: Src) -> Dst
Casts the value.
sourceimpl<T> UnwrappedAs for T
impl<T> UnwrappedAs for T
sourcefn unwrapped_as<Dst>(self) -> Dst where
T: UnwrappedCast<Dst>,
fn unwrapped_as<Dst>(self) -> Dst where
T: UnwrappedCast<Dst>,
Casts the value.
sourceimpl<Src, Dst> UnwrappedCastFrom<Src> for Dst where
Src: UnwrappedCast<Dst>,
impl<Src, Dst> UnwrappedCastFrom<Src> for Dst where
Src: UnwrappedCast<Dst>,
sourcefn unwrapped_cast_from(src: Src) -> Dst
fn unwrapped_cast_from(src: Src) -> Dst
Casts the value.
sourceimpl<T> WrappingAs for T
impl<T> WrappingAs for T
sourcefn wrapping_as<Dst>(self) -> Dst where
T: WrappingCast<Dst>,
fn wrapping_as<Dst>(self) -> Dst where
T: WrappingCast<Dst>,
Casts the value.
sourceimpl<Src, Dst> WrappingCastFrom<Src> for Dst where
Src: WrappingCast<Dst>,
impl<Src, Dst> WrappingCastFrom<Src> for Dst where
Src: WrappingCast<Dst>,
sourcefn wrapping_cast_from(src: Src) -> Dst
fn wrapping_cast_from(src: Src) -> Dst
Casts the value.