Struct Modifiers

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

The modifiers.

This type is a thin wrappers around keyboard_types::Modifiers, mostly for the convenience methods. If those get upstreamed, it will simply become that type.

Implementations§

Source§

impl Modifiers

Source

pub const ALT: Modifiers

Source

pub const ALT_GRAPH: Modifiers

Source

pub const CAPS_LOCK: Modifiers

Source

pub const CONTROL: Modifiers

Source

pub const FN: Modifiers

Source

pub const FN_LOCK: Modifiers

Source

pub const META: Modifiers

Source

pub const NUM_LOCK: Modifiers

Source

pub const SCROLL_LOCK: Modifiers

Source

pub const SHIFT: Modifiers

Source

pub const SYMBOL: Modifiers

Source

pub const SYMBOL_LOCK: Modifiers

Source

pub const HYPER: Modifiers

Source

pub const SUPER: Modifiers

Source

pub fn raw(&self) -> Modifiers

Get the inner value.

Note that this function might go away if our changes are upstreamed.

Source

pub fn shift(&self) -> bool

Determine whether Shift is set.

Source

pub fn ctrl(&self) -> bool

Determine whether Ctrl is set.

Source

pub fn alt(&self) -> bool

Determine whether Alt is set.

Source

pub fn meta(&self) -> bool

Determine whether Meta is set.

Source

pub fn empty() -> Modifiers

Returns an empty set of modifiers.

Source

pub fn is_empty(&self) -> bool

Returns true if no modifiers are set.

Source

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

Returns true if all the modifiers in other are set.

Source

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

Inserts or removes the specified modifiers depending on the passed value.

Trait Implementations§

Source§

impl BitAnd for Modifiers

Source§

type Output = Modifiers

The resulting type after applying the & operator.
Source§

fn bitand(self, rhs: Self) -> Self

Performs the & operation. Read more
Source§

impl BitAndAssign for Modifiers

Source§

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation. Read more
Source§

impl BitOr for Modifiers

Source§

type Output = Modifiers

The resulting type after applying the | operator.
Source§

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

Performs the | operation. Read more
Source§

impl BitOrAssign for Modifiers

Source§

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation. Read more
Source§

impl BitXor for Modifiers

Source§

type Output = Modifiers

The resulting type after applying the ^ operator.
Source§

fn bitxor(self, rhs: Self) -> Self

Performs the ^ operation. Read more
Source§

impl BitXorAssign for Modifiers

Source§

fn bitxor_assign(&mut self, rhs: Self)

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 · Source§

const 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 From<RawMods> for Modifiers

Source§

fn from(src: RawMods) -> Modifiers

Converts to this type from the input type.
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 Not for Modifiers

Source§

type Output = Modifiers

The resulting type after applying the ! operator.
Source§

fn not(self) -> Self

Performs the unary ! operation. Read more
Source§

impl PartialEq<Modifiers> for RawMods

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

const 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 PartialEq<Modifiers> for SysMods

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

const 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 PartialEq<RawMods> for Modifiers

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

const 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 PartialEq<SysMods> for Modifiers

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

const 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 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 · Source§

const 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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> RoundFrom<T> for T

Source§

fn round_from(x: T) -> T

Performs the conversion.
Source§

impl<T, U> RoundInto<U> for T
where U: RoundFrom<T>,

Source§

fn round_into(self) -> U

Performs the conversion.
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more