Struct Modifiers 

pub struct Modifiers {
    pub control: bool,
    pub alt: bool,
    pub shift: bool,
    pub platform: bool,
    pub function: bool,
}

The modifier keys held at some point in time.

Each field is true when that key is down. Use Modifiers::secondary for the shortcut key that matches each platform’s convention, and the constructors such as Modifiers::shift to build a value.

Fields

control: bool

The control key.

alt: bool

The alt key, also known as option on macOS.

shift: bool

The shift key.

platform: bool

The platform key: command on macOS, the Windows key on Windows, and the super key on Linux.

function: bool

The function key.

Implementations

impl Modifiers

pub fn modified(&self) -> bool

Returns whether any modifier key is held.

pub fn secondary(&self) -> bool

Returns whether the platform’s shortcut modifier is held.

This is platform (command) on macOS and control on Linux and Windows. Use it for shortcuts such as save and copy, so that they follow each platform’s convention.

Examples

assert!(Modifiers::secondary_key().secondary());
assert!(!Modifiers::shift().secondary());

pub fn number_of_modifiers(&self) -> u8

Returns how many modifier keys are held.

pub fn none() -> Modifiers

Returns Modifiers with no modifiers held.

pub fn command() -> Modifiers

Returns Modifiers with only platform held: command on macOS, the Windows key on Windows and the super key on Linux.

pub fn secondary_key() -> Modifiers

Returns Modifiers with only the secondary key held: platform on macOS and control elsewhere.

pub fn windows() -> Modifiers

Returns Modifiers with only the Windows key held. This is platform, the same as Modifiers::command.

pub fn super_key() -> Modifiers

Returns Modifiers with only the super key held. This is platform, the same as Modifiers::command.

pub fn control() -> Modifiers

Returns Modifiers with only control held.

pub fn alt() -> Modifiers

Returns Modifiers with only alt held.

pub fn shift() -> Modifiers

Returns Modifiers with only shift held.

pub fn function() -> Modifiers

Returns Modifiers with only the function key held.

pub fn command_shift() -> Modifiers

Returns Modifiers with platform and shift held.

pub fn control_shift() -> Modifiers

Returns Modifiers with control and shift held.

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

Returns whether every modifier held in self is also held in other.

Modifiers::none() is a subset of every value, and no value is a subset of none() unless it is none() itself.

Examples

let ctrl_shift = Modifiers::control_shift();
assert!(Modifiers::shift().is_subset_of(&ctrl_shift));
assert!(!Modifiers::alt().is_subset_of(&ctrl_shift));

Trait Implementations

impl BitAnd for Modifiers

type Output = Modifiers

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitAndAssign for Modifiers

fn bitand_assign(&mut self, other: Self)

Performs the &= operation.

impl BitOr for Modifiers

type Output = Modifiers

The resulting type after applying the | operator.

fn bitor(self, other: Self) -> Self::Output

Performs the | operation.

impl BitOrAssign for Modifiers

fn bitor_assign(&mut self, other: Self)

Performs the |= operation.

impl BitXor for Modifiers

type Output = Modifiers

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl BitXorAssign for Modifiers

fn bitxor_assign(&mut self, other: Self)

Performs the ^= operation.

impl Clone for Modifiers

fn clone(&self) -> Self

Returns a duplicate 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

Formats the value using the given formatter.

impl Default for Modifiers

fn default() -> Self

Returns the “default value” for a type.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Modifiers

impl Hash for Modifiers

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

Feeds a slice of this type into the given Hasher.

impl JsonSchema for Modifiers

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for Modifiers

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Modifiers

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Modifiers