Struct MouseButton

pub struct MouseButton(/* private fields */);

A u32 bit mask of all mouse buttons that were pressed during a given mouse event.

This is a bit mask because it is possible for multiple buttons to be pressed simultaneously during a given input event.

Implementations

impl MouseButton

pub const PRIMARY: MouseButton

The primary mouse button, typically the left-click button.

pub const SECONDARY: MouseButton

The secondary mouse button, typically the right-click button.

pub const MIDDLE: MouseButton

The middle mouse button, typically the scroll-wheel click button.

pub const BACK: MouseButton

The fourth mouse button, typically used for back navigation.

pub const FORWARD: MouseButton

The fifth mouse button, typically used for forward navigation.

impl MouseButton

pub const fn empty() -> MouseButton

Get a flags value with all bits unset.

pub const fn all() -> MouseButton

Get a flags value with all known bits set.

pub const fn bits(&self) -> u32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u32) -> Option<MouseButton>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u32) -> MouseButton

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u32) -> MouseButton

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<MouseButton>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: MouseButton) -> bool

Whether any set bits in a source flags value are also set in a target flags value.

pub const fn contains(&self, other: MouseButton) -> bool

Whether all set bits in a source flags value are also set in a target flags value.

pub fn insert(&mut self, other: MouseButton)

The bitwise or (|) of the bits in two flags values.

pub fn remove(&mut self, other: MouseButton)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: MouseButton)

The bitwise exclusive-or (^) of the bits in two flags values.

pub fn set(&mut self, other: MouseButton, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: MouseButton) -> MouseButton

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: MouseButton) -> MouseButton

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: MouseButton) -> MouseButton

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: MouseButton) -> MouseButton

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> MouseButton

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl MouseButton

pub const fn iter(&self) -> Iter<MouseButton>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<MouseButton>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

impl MouseButton

pub fn is_primary(&self) -> bool

Returns true if the primary mouse button is pressed.

pub fn is_secondary(&self) -> bool

Returns true if the secondary mouse button is pressed.

pub fn is_middle(&self) -> bool

Returns true if the middle mouse button is pressed.

pub fn is_back(&self) -> bool

Returns true if the back mouse button is pressed.

pub fn is_forward(&self) -> bool

Returns true if the forward mouse button is pressed.

pub fn is_other_button(&self, n: u8) -> bool

Returns true if the nth button is pressed.

The button values are:

• n = 0: PRIMARY
• n = 1: SECONDARY
• n = 2: MIDDLE
• n = 3: BACK
• n = 4: FORWARD
• n > 4: other/custom

pub fn from_raw_button(raw: usize) -> MouseButton

Returns a MouseButton bit mask based on the raw button value: 1 << raw.

A raw button value is a number that represents a mouse button, like so:

• 0: MouseButton::PRIMARY
• 1: MouseButton::SECONDARY
• 2: MouseButton::MIDDLE
• 3: MouseButton::BACK
• 4: MouseButton::FORWARD
• etc.

Trait Implementations

impl Binary for MouseButton

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl BitAnd for MouseButton

fn bitand(self, other: MouseButton) -> MouseButton

The bitwise and (&) of the bits in two flags values.

type Output = MouseButton

The resulting type after applying the & operator.

impl BitAndAssign for MouseButton

fn bitand_assign(&mut self, other: MouseButton)

The bitwise and (&) of the bits in two flags values.

impl BitOr for MouseButton

fn bitor(self, other: MouseButton) -> MouseButton

The bitwise or (|) of the bits in two flags values.

type Output = MouseButton

The resulting type after applying the | operator.

impl BitOrAssign for MouseButton

fn bitor_assign(&mut self, other: MouseButton)

The bitwise or (|) of the bits in two flags values.

impl BitXor for MouseButton

fn bitxor(self, other: MouseButton) -> MouseButton

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = MouseButton

The resulting type after applying the ^ operator.

impl BitXorAssign for MouseButton

fn bitxor_assign(&mut self, other: MouseButton)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for MouseButton

fn clone(&self) -> MouseButton

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MouseButton

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for MouseButton

fn default() -> MouseButton

Returns the “default value” for a type.

impl Extend<MouseButton> for MouseButton

fn extend<T>(&mut self, iterator: T)

where T: IntoIterator<Item = MouseButton>,

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for MouseButton

const FLAGS: &'static [Flag<MouseButton>]

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> MouseButton

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<MouseButton> for MouseButton

fn from_iter<T>(iterator: T) -> MouseButton

where T: IntoIterator<Item = MouseButton>,

The bitwise or (|) of the bits in each flags value.

impl IntoIterator for MouseButton

type Item = MouseButton

The type of the elements being iterated over.

type IntoIter = Iter<MouseButton>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <MouseButton as IntoIterator>::IntoIter

Creates an iterator from a value.

impl LowerHex for MouseButton

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Not for MouseButton

fn not(self) -> MouseButton

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = MouseButton

The resulting type after applying the ! operator.

impl Octal for MouseButton

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl PartialEq for MouseButton

fn eq(&self, other: &MouseButton) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Sub for MouseButton

fn sub(self, other: MouseButton) -> MouseButton

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = MouseButton

The resulting type after applying the - operator.

impl SubAssign for MouseButton

fn sub_assign(&mut self, other: MouseButton)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for MouseButton

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Copy for MouseButton

impl Eq for MouseButton

impl StructuralPartialEq for MouseButton