pub struct Modifiers(_);
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§

§

impl Modifiers

pub const ALT: Modifiers = Modifiers(keyboard_types::Modifiers::ALT)

pub const ALT_GRAPH: Modifiers = Modifiers(keyboard_types::Modifiers::ALT_GRAPH)

pub const CAPS_LOCK: Modifiers = Modifiers(keyboard_types::Modifiers::CAPS_LOCK)

pub const CONTROL: Modifiers = Modifiers(keyboard_types::Modifiers::CONTROL)

pub const FN: Modifiers = Modifiers(keyboard_types::Modifiers::FN)

pub const FN_LOCK: Modifiers = Modifiers(keyboard_types::Modifiers::FN_LOCK)

pub const META: Modifiers = Modifiers(keyboard_types::Modifiers::META)

pub const NUM_LOCK: Modifiers = Modifiers(keyboard_types::Modifiers::NUM_LOCK)

pub const SCROLL_LOCK: Modifiers = Modifiers(keyboard_types::Modifiers::SCROLL_LOCK)

pub const SHIFT: Modifiers = Modifiers(keyboard_types::Modifiers::SHIFT)

pub const SYMBOL: Modifiers = Modifiers(keyboard_types::Modifiers::SYMBOL)

pub const SYMBOL_LOCK: Modifiers = Modifiers(keyboard_types::Modifiers::SYMBOL_LOCK)

pub const HYPER: Modifiers = Modifiers(keyboard_types::Modifiers::HYPER)

pub const SUPER: Modifiers = Modifiers(keyboard_types::Modifiers::SUPER)

pub fn raw(&self) -> Modifiers

Get the inner value.

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

pub fn shift(&self) -> bool

Determine whether Shift is set.

pub fn ctrl(&self) -> bool

Determine whether Ctrl is set.

pub fn alt(&self) -> bool

Determine whether Alt is set.

pub fn meta(&self) -> bool

Determine whether Meta is set.

pub fn empty() -> Modifiers

Returns an empty set of modifiers.

pub fn is_empty(&self) -> bool

Returns true if no modifiers are set.

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

Returns true if all the modifiers in other are set.

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

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

Trait Implementations§

§

impl BitAnd<Modifiers> for Modifiers

§

type Output = Modifiers

The resulting type after applying the & operator.
§

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

Performs the & operation. Read more
§

impl BitAndAssign<Modifiers> for Modifiers

§

fn bitand_assign(&mut self, rhs: Modifiers)

Performs the &= operation. Read more
§

impl BitOr<Modifiers> for Modifiers

§

type Output = Modifiers

The resulting type after applying the | operator.
§

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

Performs the | operation. Read more
§

impl BitOrAssign<Modifiers> for Modifiers

§

fn bitor_assign(&mut self, rhs: Modifiers)

Performs the |= operation. Read more
§

impl BitXor<Modifiers> for Modifiers

§

type Output = Modifiers

The resulting type after applying the ^ operator.
§

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

Performs the ^ operation. Read more
§

impl BitXorAssign<Modifiers> for Modifiers

§

fn bitxor_assign(&mut self, rhs: Modifiers)

Performs the ^= operation. Read more
§

impl Clone for Modifiers

§

fn clone(&self) -> Modifiers

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
§

impl Debug for Modifiers

§

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

Formats the value using the given formatter. Read more
§

impl Default for Modifiers

§

fn default() -> Modifiers

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

impl From<RawMods> for Modifiers

§

fn from(src: RawMods) -> Modifiers

Converts to this type from the input type.
§

impl Hash for Modifiers

§

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

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
§

impl Not for Modifiers

§

type Output = Modifiers

The resulting type after applying the ! operator.
§

fn not(self) -> Modifiers

Performs the unary ! operation. Read more
§

impl PartialEq<Modifiers> for Modifiers

§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

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

impl PartialEq<Modifiers> for RawMods

§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

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

impl PartialEq<Modifiers> for SysMods

§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

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

impl PartialEq<RawMods> for Modifiers

§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

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

impl PartialEq<SysMods> for Modifiers

§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

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

impl Copy for Modifiers

§

impl Eq for Modifiers

§

impl StructuralEq for Modifiers

§

impl StructuralPartialEq for Modifiers

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> AnyEq for Twhere T: Any + PartialEq<T>,

§

fn equals(&self, other: &(dyn Any + 'static)) -> bool

§

fn as_any(&self) -> &(dyn Any + 'static)

source§

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

const: unstable · source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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 Twhere U: From<T>,

const: unstable · 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.

§

impl<T> IsDefault for Twhere T: Default + PartialEq<T> + Copy,

§

fn is_default(&self) -> bool

Checks that type has a default value.
§

impl<T> Pointable for T

§

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> RoundFrom<T> for T

§

fn round_from(x: T) -> T

Performs the conversion.
§

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

§

fn round_into(self) -> U

Performs the conversion.
source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere T: Clone,

§

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 Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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