Struct Modifier 

pub struct Modifier { /* private fields */ }

The modifier settings for an Item when a modifier key is pressed.

Implementations

impl Modifier

pub fn new(key: Key) -> Self

Create a new modifier.

pub fn new_multi(keys: impl IntoIterator<Item = Key>) -> Self

Create a new modifier with multiple keys.

Examples

let m = Modifier::new_multi([Key::Command, Key::Option]);

pub fn subtitle(self, subtitle: impl Into<String>) -> Self

The subtitle for when this modifier is activated.

pub fn arg(self, arg: impl Into<String>) -> Self

The arg for when this modifier is activated.

pub fn icon(self, arg: Icon) -> Self

The icon for when this modifier is activated.

pub fn valid(self, valid: bool) -> Self

Whether this item is valid when the modifier is activated.

pub fn variables<K, V>( self, variables: impl IntoIterator<Item = (K, V)>, ) -> Self

where K: Into<String>, V: Into<String>,

Override the variables when the item is actioned with this modifier.

See Output::variables for more information.

• If not set, inherits the item variables.

• If set, overrides the item’s variables.

  let m = Modifier::new(Key::Command).variables([("key1", "value1")]);

• If set to an empty object, no variables are passed out.

  let m = Modifier::new(Key::Command).variables::<&str, &str>([]);

Trait Implementations

impl Clone for Modifier

fn clone(&self) -> Modifier

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Modifier

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

Formats the value using the given formatter.

impl Hash for Modifier

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 PartialEq for Modifier

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Modifier

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Modifier

impl StructuralPartialEq for Modifier