Struct alfred::Item

pub struct Item<'a> {
    pub title: Cow<'a, str>,
    pub subtitle: Option<Cow<'a, str>>,
    pub icon: Option<Icon<'a>>,
    pub uid: Option<Cow<'a, str>>,
    pub arg: Option<Cow<'a, str>>,
    pub type_: ItemType,
    pub valid: bool,
    pub autocomplete: Option<Cow<'a, str>>,
    pub text_copy: Option<Cow<'a, str>>,
    pub text_large_type: Option<Cow<'a, str>>,
    pub quicklook_url: Option<Cow<'a, str>>,
    pub modifiers: HashMap<Modifier, ModifierData<'a>>,
}

Representation of an <item>

Fields

title: Cow<'a, str>

Title for the item

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

Subtitle for the item

The subtitle may be overridden by modifiers.

icon: Option<Icon<'a>>

Icon for the item

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

Identifier for the results

If given, must be unique among items, and is used for prioritizing feedback results based on usage. If blank, Alfred presents results in the order given and does not learn from them.

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

The value that is passed to the next portion of the workflow when this item is selected

The arg may be overridden by modifiers.

type_: ItemType

What type of result this is

valid: bool

Whether or not the result is valid

When false, actioning the result will populate the search field with the autocomplete value instead.

The validity may be overridden by modifiers.

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

Autocomplete data for the item

This value is populated into the search field if the tab key is pressed. If valid = false, this value is populated if the item is actioned.

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

What text the user gets when copying the result

This value is copied if the user presses ⌘C.

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

What text the user gets when displaying large type

This value is displayed if the user presses ⌘L.

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

A URL to use for Quick Look

modifiers: HashMap<Modifier, ModifierData<'a>>

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

Methods

impl<'a> Item<'a>

fn write_xml(&self, w: &mut Write, indent: u32) -> Result<()>

Writes the XML fragment representing the Item to the Write

XMLWriter should be used instead if at all possible, in order to write the XML header/footer and maintain proper error discipline.

impl<'a> Item<'a>

fn new<S: Into<Cow<'a, str>>>(title: S) -> Item<'a>

Returns a new Item with the given title

Trait Implementations

impl<'a> ToJson for Item<'a>

fn to_json(&self) -> Result<Value>

Represent self as a serde_json::Value. Note that Value is not a JSON string. If you need a string, use serde_json::to_string instead.

impl<'a> PartialEq for Item<'a>

fn eq(&self, __arg_0: &Item<'a>) -> bool

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

fn ne(&self, __arg_0: &Item<'a>) -> bool

This method tests for !=.

impl<'a> Eq for Item<'a>

impl<'a> Clone for Item<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.