Skip to main content

Modifiers

Struct Modifiers 

Source
pub struct Modifiers(/* private fields */);
Expand description

A set of held modifier keys.

Backed by a private bit set so the in-memory representation can grow (e.g. to u16) without changing the public API, and so no third-party bit-flags type leaks into this crate’s semver surface.

Implementations§

Source§

impl Modifiers

Source

pub const NONE: Modifiers

No modifiers held.

Source

pub const CTRL: Modifiers

The Control modifier.

Source

pub const ALT: Modifiers

The Alt / Option modifier.

Source

pub const SHIFT: Modifiers

The Shift modifier.

Source

pub const SUPER: Modifiers

The Super / Command / Windows modifier.

Source

pub const fn empty() -> Self

Returns the empty modifier set (alias for Modifiers::NONE).

Source

pub const fn is_empty(self) -> bool

Returns true if no modifiers are held.

Source

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

Returns true if every modifier in other is also held in self.

Source

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

Returns the union of two modifier sets.

Source

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

Returns self with every modifier in other removed.

Trait Implementations§

Source§

impl BitOr for Modifiers

Source§

type Output = Modifiers

The resulting type after applying the | operator.
Source§

fn bitor(self, rhs: Modifiers) -> Modifiers

Performs the | operation. Read more
Source§

impl BitOrAssign for Modifiers

Source§

fn bitor_assign(&mut self, rhs: Modifiers)

Performs the |= operation. Read more
Source§

impl Clone for Modifiers

Source§

fn clone(&self) -> Modifiers

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Modifiers

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Modifiers

Source§

fn default() -> Modifiers

Returns the “default value” for a type. Read more
Source§

impl Hash for Modifiers

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Modifiers

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Copy for Modifiers

Source§

impl Eq for Modifiers

Source§

impl StructuralPartialEq for Modifiers

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.