Struct rsynth::backend::vst_backend::vst::api::ModifierKey
source · pub struct ModifierKey { /* private fields */ }
Expand description
Cross platform modifier key flags.
Implementations§
source§impl ModifierKey
impl ModifierKey
sourcepub const SHIFT: ModifierKey = _
pub const SHIFT: ModifierKey = _
Shift key.
sourcepub const ALT: ModifierKey = _
pub const ALT: ModifierKey = _
Alt key.
sourcepub const COMMAND: ModifierKey = _
pub const COMMAND: ModifierKey = _
Control on mac.
sourcepub const CONTROL: ModifierKey = _
pub const CONTROL: ModifierKey = _
Command on mac, ctrl on other.
sourcepub const fn empty() -> ModifierKey
pub const fn empty() -> ModifierKey
Returns an empty set of flags
sourcepub const fn all() -> ModifierKey
pub const fn all() -> ModifierKey
Returns the set containing all flags.
sourcepub fn from_bits(bits: u8) -> Option<ModifierKey>
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.
sourcepub const fn from_bits_truncate(bits: u8) -> ModifierKey
pub const fn from_bits_truncate(bits: u8) -> ModifierKey
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u8) -> ModifierKey
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).
sourcepub const fn intersects(&self, other: ModifierKey) -> bool
pub const fn intersects(&self, other: ModifierKey) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: ModifierKey) -> bool
pub const fn contains(&self, other: ModifierKey) -> bool
Returns true
all of the flags in other
are contained within self
.
sourcepub fn insert(&mut self, other: ModifierKey)
pub fn insert(&mut self, other: ModifierKey)
Inserts the specified flags in-place.
sourcepub fn remove(&mut self, other: ModifierKey)
pub fn remove(&mut self, other: ModifierKey)
Removes the specified flags in-place.
sourcepub fn toggle(&mut self, other: ModifierKey)
pub fn toggle(&mut self, other: ModifierKey)
Toggles the specified flags in-place.
sourcepub fn set(&mut self, other: ModifierKey, value: bool)
pub fn set(&mut self, other: ModifierKey, value: bool)
Inserts or removes the specified flags depending on the passed value.
Trait Implementations§
source§impl Binary for ModifierKey
impl Binary for ModifierKey
source§impl BitAnd for ModifierKey
impl BitAnd for ModifierKey
source§fn bitand(self, other: ModifierKey) -> ModifierKey
fn bitand(self, other: ModifierKey) -> ModifierKey
Returns the intersection between the two sets of flags.
§type Output = ModifierKey
type Output = ModifierKey
&
operator.source§impl BitAndAssign for ModifierKey
impl BitAndAssign for ModifierKey
source§fn bitand_assign(&mut self, other: ModifierKey)
fn bitand_assign(&mut self, other: ModifierKey)
Disables all flags disabled in the set.
source§impl BitOr for ModifierKey
impl BitOr for ModifierKey
source§fn bitor(self, other: ModifierKey) -> ModifierKey
fn bitor(self, other: ModifierKey) -> ModifierKey
Returns the union of the two sets of flags.
§type Output = ModifierKey
type Output = ModifierKey
|
operator.source§impl BitOrAssign for ModifierKey
impl BitOrAssign for ModifierKey
source§fn bitor_assign(&mut self, other: ModifierKey)
fn bitor_assign(&mut self, other: ModifierKey)
Adds the set of flags.
source§impl BitXor for ModifierKey
impl BitXor for ModifierKey
source§fn bitxor(self, other: ModifierKey) -> ModifierKey
fn bitxor(self, other: ModifierKey) -> ModifierKey
Returns the left flags, but with all the right flags toggled.
§type Output = ModifierKey
type Output = ModifierKey
^
operator.source§impl BitXorAssign for ModifierKey
impl BitXorAssign for ModifierKey
source§fn bitxor_assign(&mut self, other: ModifierKey)
fn bitxor_assign(&mut self, other: ModifierKey)
Toggles the set of flags.
source§impl Clone for ModifierKey
impl Clone for ModifierKey
source§fn clone(&self) -> ModifierKey
fn clone(&self) -> ModifierKey
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ModifierKey
impl Debug for ModifierKey
source§impl Extend<ModifierKey> for ModifierKey
impl Extend<ModifierKey> for ModifierKey
source§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = ModifierKey>,
fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = ModifierKey>,
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl FromIterator<ModifierKey> for ModifierKey
impl FromIterator<ModifierKey> for ModifierKey
source§fn from_iter<T>(iterator: T) -> ModifierKeywhere
T: IntoIterator<Item = ModifierKey>,
fn from_iter<T>(iterator: T) -> ModifierKeywhere
T: IntoIterator<Item = ModifierKey>,
source§impl Hash for ModifierKey
impl Hash for ModifierKey
source§impl LowerHex for ModifierKey
impl LowerHex for ModifierKey
source§impl Not for ModifierKey
impl Not for ModifierKey
source§fn not(self) -> ModifierKey
fn not(self) -> ModifierKey
Returns the complement of this set of flags.
§type Output = ModifierKey
type Output = ModifierKey
!
operator.source§impl Octal for ModifierKey
impl Octal for ModifierKey
source§impl Ord for ModifierKey
impl Ord for ModifierKey
source§fn cmp(&self, other: &ModifierKey) -> Ordering
fn cmp(&self, other: &ModifierKey) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl PartialEq for ModifierKey
impl PartialEq for ModifierKey
source§fn eq(&self, other: &ModifierKey) -> bool
fn eq(&self, other: &ModifierKey) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for ModifierKey
impl PartialOrd for ModifierKey
source§fn partial_cmp(&self, other: &ModifierKey) -> Option<Ordering>
fn partial_cmp(&self, other: &ModifierKey) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl Sub for ModifierKey
impl Sub for ModifierKey
source§fn sub(self, other: ModifierKey) -> ModifierKey
fn sub(self, other: ModifierKey) -> ModifierKey
Returns the set difference of the two sets of flags.
§type Output = ModifierKey
type Output = ModifierKey
-
operator.source§impl SubAssign for ModifierKey
impl SubAssign for ModifierKey
source§fn sub_assign(&mut self, other: ModifierKey)
fn sub_assign(&mut self, other: ModifierKey)
Disables all flags enabled in the set.