ModifierData

Struct ModifierData 

Source
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>>,
    /* private fields */
}
Expand description

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.

Implementations§

Source§

impl<'a> ModifierData<'a>

Source

pub fn to_json(&self) -> Value

Serializes the ModifierData into its JSON representation.

Source§

impl<'a> ModifierData<'a>

Source

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

Returns a new ModifierData where all fields are None.

Trait Implementations§

Source§

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

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

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

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn default() -> ModifierData<'a>

Returns the “default value” for a type. Read more
Source§

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

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

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

Source§

impl<'a> StructuralPartialEq for ModifierData<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for ModifierData<'a>

§

impl<'a> RefUnwindSafe for ModifierData<'a>

§

impl<'a> Send for ModifierData<'a>

§

impl<'a> Sync for ModifierData<'a>

§

impl<'a> Unpin for ModifierData<'a>

§

impl<'a> UnwindSafe for ModifierData<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.