Struct ambient_api::prelude::ModifiersState

pub struct ModifiersState { /* private fields */ }

Represents the current state of the keyboard modifiers

Each flag represents a modifier and is set if this modifier is active.

Implementations

impl ModifiersState

pub fn shift(&self) -> bool

Returns true if the shift key is pressed.

pub fn ctrl(&self) -> bool

Returns true if the control key is pressed.

pub fn alt(&self) -> bool

Returns true if the alt key is pressed.

pub fn logo(&self) -> bool

Returns true if the logo key is pressed.

impl ModifiersState

pub const SHIFT: ModifiersState = _

The “shift” key.

pub const CTRL: ModifiersState = _

The “control” key.

pub const ALT: ModifiersState = _

The “alt” key.

pub const LOGO: ModifiersState = _

This is the “windows” key on PC and “command” key on Mac.

pub const fn empty() -> ModifiersState

Returns an empty set of flags.

pub const fn all() -> ModifiersState

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

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

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) -> ModifiersState

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

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

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

Safety

The caller of the bitflags! macro can chose to allow or disallow extra bits for their bitflags type.

The caller of from_bits_unchecked() has to ensure that all bits correspond to a defined flag or that extra bits are valid for this bitflags type.

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: ModifiersState) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

pub const fn intersection(self, other: ModifiersState) -> ModifiersState

Returns the intersection between the flags in self and other.

Specifically, the returned set contains only the flags which are present in both self and other.

This is equivalent to using the & operator (e.g. ops::BitAnd), as in flags & other.

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

Returns the union of between the flags in self and other.

Specifically, the returned set contains all flags which are present in either self or other, including any which are present in both (see Self::symmetric_difference if that is undesirable).

This is equivalent to using the | operator (e.g. ops::BitOr), as in flags | other.

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

Returns the difference between the flags in self and other.

Specifically, the returned set contains all flags present in self, except for the ones present in other.

It is also conceptually equivalent to the “bit-clear” operation: flags & !other (and this syntax is also supported).

This is equivalent to using the - operator (e.g. ops::Sub), as in flags - other.

pub const fn symmetric_difference(self, other: ModifiersState) -> ModifiersState

Returns the symmetric difference between the flags in self and other.

Specifically, the returned set contains the flags present which are present in self or other, but that are not present in both. Equivalently, it contains the flags present in exactly one of the sets self and other.

This is equivalent to using the ^ operator (e.g. ops::BitXor), as in flags ^ other.

pub const fn complement(self) -> ModifiersState

Returns the complement of this set of flags.

Specifically, the returned set contains all the flags which are not set in self, but which are allowed for this type.

Alternatively, it can be thought of as the set difference between Self::all() and self (e.g. Self::all() - self)

This is equivalent to using the ! operator (e.g. ops::Not), as in !flags.

Trait Implementations

impl Binary for ModifiersState

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

Formats the value using the given formatter.

impl BitAnd for ModifiersState

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

Returns the intersection between the two sets of flags.

type Output = ModifiersState

The resulting type after applying the & operator.

impl BitAndAssign for ModifiersState

fn bitand_assign(&mut self, other: ModifiersState)

Disables all flags disabled in the set.

impl BitOr for ModifiersState

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

Returns the union of the two sets of flags.

type Output = ModifiersState

The resulting type after applying the | operator.

impl BitOrAssign for ModifiersState

fn bitor_assign(&mut self, other: ModifiersState)

Adds the set of flags.

impl BitXor for ModifiersState

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

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

type Output = ModifiersState

The resulting type after applying the ^ operator.

impl BitXorAssign for ModifiersState

fn bitxor_assign(&mut self, other: ModifiersState)

Toggles the set of flags.

impl Clone for ModifiersState

fn clone(&self) -> ModifiersState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ModifiersState

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

Formats the value using the given formatter.

impl Default for ModifiersState

fn default() -> ModifiersState

Returns the “default value” for a type.

impl Extend<ModifiersState> for ModifiersState

fn extend<T>(&mut self, iterator: T)

where T: IntoIterator<Item = ModifiersState>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<ModifiersState> for ModifiersState

fn from_iter<T>(iterator: T) -> ModifiersState

where T: IntoIterator<Item = ModifiersState>,

Creates a value from an iterator.

impl Hash for ModifiersState

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for ModifiersState

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

Formats the value using the given formatter.

impl Not for ModifiersState

fn not(self) -> ModifiersState

Returns the complement of this set of flags.

type Output = ModifiersState

The resulting type after applying the ! operator.

impl Octal for ModifiersState

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

Formats the value using the given formatter.

impl Ord for ModifiersState

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for ModifiersState

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

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

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 PartialOrd for ModifiersState

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

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

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

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

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

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

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

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

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

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

impl Sub for ModifiersState

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

Returns the set difference of the two sets of flags.

type Output = ModifiersState

The resulting type after applying the - operator.

impl SubAssign for ModifiersState

fn sub_assign(&mut self, other: ModifiersState)

Disables all flags enabled in the set.

impl UpperHex for ModifiersState

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

Formats the value using the given formatter.

impl Copy for ModifiersState

impl Eq for ModifiersState

impl StructuralEq for ModifiersState

impl StructuralPartialEq for ModifiersState