Struct vst::api::ModifierKey

pub struct ModifierKey { /* fields omitted */ }

Cross platform modifier key flags.

Methods

impl ModifierKey

pub const SHIFT: ModifierKey

Shift key.

pub const ALT: ModifierKey

Alt key.

pub const COMMAND: ModifierKey

Control on mac.

pub const CONTROL: ModifierKey

Command on mac, ctrl on other.

pub const fn empty() -> ModifierKey

Returns an empty set of flags

pub const fn all() -> ModifierKey

Returns the set containing all flags.

pub const fn bits(&self) -> u8

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u8) -> Option<ModifierKey>

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

pub const fn from_bits_truncate(bits: u8) -> ModifierKey

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

pub const unsafe fn from_bits_unchecked(bits: u8) -> ModifierKey

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Extend<ModifierKey> for ModifierKey

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

Extends a collection with the contents of an iterator.

impl Clone for ModifierKey

fn clone(&self) -> ModifierKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ModifierKey

impl Eq for ModifierKey

impl Ord for ModifierKey

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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<ModifierKey> for ModifierKey

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

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

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

This method tests for !=.

impl PartialOrd<ModifierKey> for ModifierKey

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

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

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

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

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

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

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

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

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

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

impl Debug for ModifierKey

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

Formats the value using the given formatter.

impl Sub<ModifierKey> for ModifierKey

type Output = ModifierKey

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<ModifierKey> for ModifierKey

fn sub_assign(&mut self, other: ModifierKey)

Disables all flags enabled in the set.

impl Not for ModifierKey

type Output = ModifierKey

The resulting type after applying the ! operator.

fn not(self) -> ModifierKey

Returns the complement of this set of flags.

impl BitAnd<ModifierKey> for ModifierKey

type Output = ModifierKey

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitOr<ModifierKey> for ModifierKey

type Output = ModifierKey

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitXor<ModifierKey> for ModifierKey

type Output = ModifierKey

The resulting type after applying the ^ operator.

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

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

impl BitAndAssign<ModifierKey> for ModifierKey

fn bitand_assign(&mut self, other: ModifierKey)

Disables all flags disabled in the set.

impl BitOrAssign<ModifierKey> for ModifierKey

fn bitor_assign(&mut self, other: ModifierKey)

Adds the set of flags.

impl BitXorAssign<ModifierKey> for ModifierKey

fn bitxor_assign(&mut self, other: ModifierKey)

Toggles the set of flags.

impl Hash for ModifierKey

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

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 StructuralPartialEq for ModifierKey

impl StructuralEq for ModifierKey

impl FromIterator<ModifierKey> for ModifierKey

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

Creates a value from an iterator.

impl Octal for ModifierKey

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

Formats the value using the given formatter.

impl Binary for ModifierKey

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

Formats the value using the given formatter.

impl LowerHex for ModifierKey

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

Formats the value using the given formatter.

impl UpperHex for ModifierKey

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

Formats the value using the given formatter.