Struct spectrusty::peripherals::mouse::MouseButtons
source · pub struct MouseButtons { /* private fields */ }
Expand description
Flags for mouse buttons.
- Bit = 1 button is pressed.
- Bit = 0 button is released.
Implementations§
source§impl MouseButtons
impl MouseButtons
pub const LEFT: MouseButtons = Self{ bits: 1,}
pub const RIGHT: MouseButtons = Self{ bits: 2,}
pub const MIDDLE: MouseButtons = Self{ bits: 4,}
pub const FOURTH: MouseButtons = Self{ bits: 16,}
pub const FIFTH: MouseButtons = Self{ bits: 32,}
pub const SIXTH: MouseButtons = Self{ bits: 64,}
pub const SEVENTH: MouseButtons = Self{ bits: 128,}
sourcepub const fn empty() -> MouseButtons
pub const fn empty() -> MouseButtons
Returns an empty set of flags.
sourcepub const fn all() -> MouseButtons
pub const fn all() -> MouseButtons
Returns the set containing all flags.
sourcepub const fn from_bits(bits: u8) -> Option<MouseButtons>
pub const fn from_bits(bits: u8) -> Option<MouseButtons>
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) -> MouseButtons
pub const fn from_bits_truncate(bits: u8) -> MouseButtons
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u8) -> MouseButtons
pub const unsafe fn from_bits_unchecked(bits: u8) -> MouseButtons
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: MouseButtons) -> bool
pub const fn intersects(&self, other: MouseButtons) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: MouseButtons) -> bool
pub const fn contains(&self, other: MouseButtons) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn insert(&mut self, other: MouseButtons)
pub fn insert(&mut self, other: MouseButtons)
Inserts the specified flags in-place.
sourcepub fn remove(&mut self, other: MouseButtons)
pub fn remove(&mut self, other: MouseButtons)
Removes the specified flags in-place.
sourcepub fn toggle(&mut self, other: MouseButtons)
pub fn toggle(&mut self, other: MouseButtons)
Toggles the specified flags in-place.
sourcepub fn set(&mut self, other: MouseButtons, value: bool)
pub fn set(&mut self, other: MouseButtons, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: MouseButtons) -> MouseButtons
pub const fn intersection(self, other: MouseButtons) -> MouseButtons
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: MouseButtons) -> MouseButtons
pub const fn union(self, other: MouseButtons) -> MouseButtons
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: MouseButtons) -> MouseButtons
pub const fn difference(self, other: MouseButtons) -> MouseButtons
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: MouseButtons) -> MouseButtons
pub const fn symmetric_difference(self, other: MouseButtons) -> MouseButtons
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) -> MouseButtons
pub const fn complement(self) -> MouseButtons
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§
source§impl Binary for MouseButtons
impl Binary for MouseButtons
source§impl BitAnd<MouseButtons> for MouseButtons
impl BitAnd<MouseButtons> for MouseButtons
source§fn bitand(self, other: MouseButtons) -> MouseButtons
fn bitand(self, other: MouseButtons) -> MouseButtons
Returns the intersection between the two sets of flags.
§type Output = MouseButtons
type Output = MouseButtons
&
operator.source§impl BitAndAssign<MouseButtons> for MouseButtons
impl BitAndAssign<MouseButtons> for MouseButtons
source§fn bitand_assign(&mut self, other: MouseButtons)
fn bitand_assign(&mut self, other: MouseButtons)
Disables all flags disabled in the set.
source§impl BitOr<MouseButtons> for MouseButtons
impl BitOr<MouseButtons> for MouseButtons
source§fn bitor(self, other: MouseButtons) -> MouseButtons
fn bitor(self, other: MouseButtons) -> MouseButtons
Returns the union of the two sets of flags.
§type Output = MouseButtons
type Output = MouseButtons
|
operator.source§impl BitOrAssign<MouseButtons> for MouseButtons
impl BitOrAssign<MouseButtons> for MouseButtons
source§fn bitor_assign(&mut self, other: MouseButtons)
fn bitor_assign(&mut self, other: MouseButtons)
Adds the set of flags.
source§impl BitXor<MouseButtons> for MouseButtons
impl BitXor<MouseButtons> for MouseButtons
source§fn bitxor(self, other: MouseButtons) -> MouseButtons
fn bitxor(self, other: MouseButtons) -> MouseButtons
Returns the left flags, but with all the right flags toggled.
§type Output = MouseButtons
type Output = MouseButtons
^
operator.source§impl BitXorAssign<MouseButtons> for MouseButtons
impl BitXorAssign<MouseButtons> for MouseButtons
source§fn bitxor_assign(&mut self, other: MouseButtons)
fn bitxor_assign(&mut self, other: MouseButtons)
Toggles the set of flags.
source§impl Clone for MouseButtons
impl Clone for MouseButtons
source§fn clone(&self) -> MouseButtons
fn clone(&self) -> MouseButtons
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for MouseButtons
impl Debug for MouseButtons
source§impl Default for MouseButtons
impl Default for MouseButtons
source§fn default() -> MouseButtons
fn default() -> MouseButtons
source§impl Extend<MouseButtons> for MouseButtons
impl Extend<MouseButtons> for MouseButtons
source§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = MouseButtons>,
fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = MouseButtons>,
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl FromIterator<MouseButtons> for MouseButtons
impl FromIterator<MouseButtons> for MouseButtons
source§fn from_iter<T>(iterator: T) -> MouseButtonswhere
T: IntoIterator<Item = MouseButtons>,
fn from_iter<T>(iterator: T) -> MouseButtonswhere
T: IntoIterator<Item = MouseButtons>,
source§impl Hash for MouseButtons
impl Hash for MouseButtons
source§impl LowerHex for MouseButtons
impl LowerHex for MouseButtons
source§impl Not for MouseButtons
impl Not for MouseButtons
source§fn not(self) -> MouseButtons
fn not(self) -> MouseButtons
Returns the complement of this set of flags.
§type Output = MouseButtons
type Output = MouseButtons
!
operator.source§impl Octal for MouseButtons
impl Octal for MouseButtons
source§impl Ord for MouseButtons
impl Ord for MouseButtons
source§fn cmp(&self, other: &MouseButtons) -> Ordering
fn cmp(&self, other: &MouseButtons) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl PartialEq<MouseButtons> for MouseButtons
impl PartialEq<MouseButtons> for MouseButtons
source§fn eq(&self, other: &MouseButtons) -> bool
fn eq(&self, other: &MouseButtons) -> bool
source§impl PartialOrd<MouseButtons> for MouseButtons
impl PartialOrd<MouseButtons> for MouseButtons
source§fn partial_cmp(&self, other: &MouseButtons) -> Option<Ordering>
fn partial_cmp(&self, other: &MouseButtons) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl Sub<MouseButtons> for MouseButtons
impl Sub<MouseButtons> for MouseButtons
source§fn sub(self, other: MouseButtons) -> MouseButtons
fn sub(self, other: MouseButtons) -> MouseButtons
Returns the set difference of the two sets of flags.
§type Output = MouseButtons
type Output = MouseButtons
-
operator.source§impl SubAssign<MouseButtons> for MouseButtons
impl SubAssign<MouseButtons> for MouseButtons
source§fn sub_assign(&mut self, other: MouseButtons)
fn sub_assign(&mut self, other: MouseButtons)
Disables all flags enabled in the set.
source§impl UpperHex for MouseButtons
impl UpperHex for MouseButtons
impl Copy for MouseButtons
impl Eq for MouseButtons
impl StructuralEq for MouseButtons
impl StructuralPartialEq for MouseButtons
Auto Trait Implementations§
impl RefUnwindSafe for MouseButtons
impl Send for MouseButtons
impl Sync for MouseButtons
impl Unpin for MouseButtons
impl UnwindSafe for MouseButtons
Blanket Implementations§
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
source§impl<S, T> IntoSample<S> for Twhere
S: FromSample<T>,
impl<S, T> IntoSample<S> for Twhere
S: FromSample<T>,
source§fn into_sample(self) -> S
fn into_sample(self) -> S
S
a sample type from self
.§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> Rwhere
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> Rwhere
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere
Self: Deref<Target = T>,
T: ?Sized,
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere
Self: Deref<Target = T>,
T: ?Sized,
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds. Read more§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
.tap_borrow()
only in debug builds, and is erased in release
builds. Read more§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
.tap_borrow_mut()
only in debug builds, and is erased in release
builds. Read more§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
.tap_ref()
only in debug builds, and is erased in release
builds. Read more§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
.tap_ref_mut()
only in debug builds, and is erased in release
builds. Read more