Struct show_image::KeyModifiers

pub struct KeyModifiers { /* fields omitted */ }

Pressed modifier keys.

Specification: https://w3c.github.io/uievents-key/#keys-modifier

Methods

impl Modifiers

pub const ALT: Modifiers

pub const ALT_GRAPH: Modifiers

pub const CAPS_LOCK: Modifiers

pub const CONTROL: Modifiers

pub const FN: Modifiers

pub const FN_LOCK: Modifiers

pub const META: Modifiers

pub const NUM_LOCK: Modifiers

pub const SCROLL_LOCK: Modifiers

pub const SHIFT: Modifiers

pub const SYMBOL: Modifiers

pub const SYMBOL_LOCK: Modifiers

pub const HYPER: Modifiers

pub const SUPER: Modifiers

pub const fn empty() -> Modifiers

Returns an empty set of flags

pub const fn all() -> Modifiers

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

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

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

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

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> Modifiers

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

Returns true if there are flags common to both self and other.

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

Returns true all of the flags in other are contained within self.

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for Modifiers

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

Formats the value using the given formatter.

impl BitAnd<Modifiers> for Modifiers

type Output = Modifiers

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<Modifiers> for Modifiers

fn bitand_assign(&mut self, other: Modifiers)

Disables all flags disabled in the set.

impl BitOr<Modifiers> for Modifiers

type Output = Modifiers

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<Modifiers> for Modifiers

fn bitor_assign(&mut self, other: Modifiers)

Adds the set of flags.

impl BitXor<Modifiers> for Modifiers

type Output = Modifiers

The resulting type after applying the ^ operator.

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

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<Modifiers> for Modifiers

fn bitxor_assign(&mut self, other: Modifiers)

Toggles the set of flags.

impl Clone for Modifiers

fn clone(&self) -> Modifiers

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Modifiers

impl Debug for Modifiers

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

Formats the value using the given formatter.

impl Default for Modifiers

fn default() -> Modifiers

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Modifiers

fn deserialize<__D>(
    __deserializer: __D
) -> Result<Modifiers, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for Modifiers

impl Extend<Modifiers> for Modifiers

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

Extends a collection with the contents of an iterator.

impl FromIterator<Modifiers> for Modifiers

fn from_iter<T>(iterator: T) -> Modifiers where
    T: IntoIterator<Item = Modifiers>, 

Creates a value from an iterator.

impl Hash for Modifiers

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl LowerHex for Modifiers

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

Formats the value using the given formatter.

impl Not for Modifiers

type Output = Modifiers

The resulting type after applying the ! operator.

fn not(self) -> Modifiers

Returns the complement of this set of flags.

impl Octal for Modifiers

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

Formats the value using the given formatter.

impl Ord for Modifiers

fn cmp(&self, other: &Modifiers) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

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 ==.

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

This method tests for !=.

impl PartialOrd<Modifiers> for Modifiers

fn partial_cmp(&self, other: &Modifiers) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Modifiers

fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for Modifiers

impl StructuralPartialEq for Modifiers

impl Sub<Modifiers> for Modifiers

type Output = Modifiers

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<Modifiers> for Modifiers

fn sub_assign(&mut self, other: Modifiers)

Disables all flags enabled in the set.

impl UpperHex for Modifiers

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

Formats the value using the given formatter.