Struct Modifiers

pub struct Modifiers(/* private field */);

The set of modifier keys that were triggered along with a key press.

Implementations

impl Modifiers

const fn empty() -> Self

Get a flags value with all bits unset.

const fn all() -> Self

Get a flags value with all known bits set.

const fn bits(&self) -> u8

Get the underlying bits value.

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

const fn from_bits(bits: u8) -> Option<Self>

Convert from a bits value.

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

const fn from_bits_truncate(bits: u8) -> Self

Convert from a bits value, unsetting any unknown bits.

const fn from_bits_retain(bits: u8) -> Self

Convert from a bits value exactly.

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

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.

const fn is_empty(&self) -> bool

Whether all bits in self are unset.

const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

Whether any set bits in other are also set in self.

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

Whether all set bits in other are also set in self.

fn insert(&mut self, other: Self)

The bitwise or (|) of the bits in self and other.

fn remove(&mut self, other: Self)

The intersection of self with the complement of other (&!).

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

fn toggle(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in self and other.

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

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

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

The bitwise and (&) of the bits in self and other.

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

The bitwise or (|) of the bits in self and other.

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

The intersection of self with the complement of other (&!).

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

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

The bitwise exclusive-or (^) of the bits in self and other.

const fn complement(self) -> Self

The bitwise negation (!) of the bits in self, truncating the result.

impl Modifiers

const CTRL: Self = _;

Control modifier

const ALT: Self = _;

Escape or Alt modifier

const SHIFT: Self = _;

Shift modifier

const NONE: Self = _;

No modifier

const CTRL_SHIFT: Self = _;

Ctrl + Shift

const ALT_SHIFT: Self = _;

Alt + Shift

const CTRL_ALT: Self = _;

Ctrl + Alt

const CTRL_ALT_SHIFT: Self = _;

Ctrl + Alt + Shift

impl Modifiers

const fn iter(&self) -> Iter<Modifiers>

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.

const fn iter_names(&self) -> IterNames<Modifiers>

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.

Trait Implementations

impl Binary for Modifiers

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

impl BitAnd for Modifiers

type Output = Modifiers;
fn bitand(self, other: Self) -> Self

The bitwise and (&) of the bits in self and other.

impl BitAndAssign for Modifiers

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in self and other.

impl BitOr for Modifiers

type Output = Modifiers;
fn bitor(self, other: Modifiers) -> Self

The bitwise or (|) of the bits in self and other.

impl BitOrAssign for Modifiers

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in self and other.

impl BitXor for Modifiers

type Output = Modifiers;
fn bitxor(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in self and other.

impl BitXorAssign for Modifiers

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in self and other.

impl Clone for Modifiers

fn clone(&self) -> Modifiers

impl Copy for Modifiers

impl Debug for Modifiers

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

impl Eq for Modifiers

impl Extend<Modifiers> for Modifiers

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

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

impl Flags for Modifiers

const FLAGS: &'static [Flag<Modifiers>] = _;
type Bits = u8;
fn bits(&self) -> u8
fn from_bits_retain(bits: u8) -> Modifiers
fn all_named() -> Modifiers

impl FromIterator<Modifiers> for Modifiers

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

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

impl Hash for Modifiers

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

impl IntoIterator for Modifiers

type Item = Modifiers;
type IntoIter = Iter<Modifiers>;
fn into_iter(self) -> Self::IntoIter

impl LowerHex for Modifiers

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

impl Not for Modifiers

type Output = Modifiers;
fn not(self) -> Self

The bitwise negation (!) of the bits in self, truncating the result.

impl Octal for Modifiers

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

impl PartialEq for Modifiers

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

impl PublicFlags for Modifiers

type Primitive = u8;
type Internal = InternalBitFlags;

impl StructuralPartialEq for Modifiers

impl Sub for Modifiers

type Output = Modifiers;
fn sub(self, other: Self) -> Self

The intersection of self with the complement of other (&!).

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

impl SubAssign for Modifiers

fn sub_assign(&mut self, other: Self)

The intersection of self with the complement of other (&!).

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 Modifiers

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

Auto Trait Implementations

impl Freeze for Modifiers

impl RefUnwindSafe for Modifiers

impl Send for Modifiers

impl Sync for Modifiers

impl Unpin for Modifiers

impl UnsafeUnpin for Modifiers

impl UnwindSafe for Modifiers

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

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

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

impl<T> From<T> for Modifiers

fn from(t: T) -> T

Returns the argument unchanged.

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

type Owned = T;
fn to_owned(&self) -> T
fn clone_into(&self, target: &mut T)

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

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, U> TryFrom<U> for Modifiers where U: Into<T>,

type Error = never;
fn try_from(value: U) -> Result<T, never>

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

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