Struct alfred::ModifierData

pub struct ModifierData<'a> {
    pub subtitle: Option<Cow<'a, str>>,
    pub arg: Option<Cow<'a, str>>,
    pub valid: Option<bool>,
    pub icon: Option<Icon<'a>>,
    pub variables: HashMap<Cow<'a, str>, Cow<'a, str>>,
    // some fields omitted
}

Optional overrides of subtitle, arg, and valid for modifiers.

Fields

subtitle: Option<Cow<'a, str>>

The subtitle to use for the current modifier.

arg: Option<Cow<'a, str>>

The arg to use for the current modifier.

valid: Option<bool>

The validity to use for the current modifier.

icon: Option<Icon<'a>>

The result icon to use for the current modifier.

This icon is only supported when using JSON output. The legacy XML output format does not support per-modifier icons.

This icon is only used with Alfred 3.4.1 or later.

variables: HashMap<Cow<'a, str>, Cow<'a, str>>

Variables to pass out of the script filter if the item is selected in Alfred's results using this modifier.

This property is only used with JSON output and only affects Alfred 3.4.1 or later.

Methods

impl<'a> ModifierData<'a>

pub fn to_json(&self) -> Value

Serializes the ModifierData into its JSON representation.

impl<'a> ModifierData<'a>

pub fn new() -> ModifierData<'a>

Returns a new ModifierData where all fields are None.

Trait Implementations

impl<'a> PartialEq<ModifierData<'a>> for ModifierData<'a>

fn eq(&self, other: &ModifierData<'a>) -> bool

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

fn ne(&self, other: &ModifierData<'a>) -> bool

This method tests for !=.

impl<'a> Default for ModifierData<'a>

fn default() -> ModifierData<'a>

Returns the "default value" for a type.

impl<'a> Clone for ModifierData<'a>

fn clone(&self) -> ModifierData<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Eq for ModifierData<'a>

impl<'a> Debug for ModifierData<'a>

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

Formats the value using the given formatter.