Crate alfred

Helpers for writing Alfred script filter output

Examples

JSON output (Alfred 3)

alfred::json::write_items(io::stdout(), &[
    alfred::Item::new("Item 1"),
    alfred::ItemBuilder::new("Item 2")
                        .subtitle("Subtitle")
                        .into_item(),
    alfred::ItemBuilder::new("Item 3")
                        .arg("Argument")
                        .subtitle("Subtitle")
                        .icon_filetype("public.folder")
                        .into_item()
])

JSON output with variables (Alfred 3)

alfred::json::Builder::with_items(&[
    alfred::Item::new("Item 1"),
    alfred::ItemBuilder::new("Item 2")
                        .subtitle("Subtitle")
                        .variable("fruit", "banana")
                        .into_item(),
    alfred::ItemBuilder::new("Item 3")
                        .arg("Argument")
                        .subtitle("Subtitle")
                        .icon_filetype("public.folder")
                        .arg_mod(Modifier::Option, "Alt Argument")
                        .variable_mod(Modifier::Option, "vegetable", "carrot")
                        .into_item()
]).variable("fruit", "banana")
  .variable("vegetable", "carrot")
  .write(io::stdout())

XML output (Alfred 2)

let mut xmlw = try!(alfred::XMLWriter::new(io::stdout()));

let item1 = alfred::Item::new("Item 1");
let item2 = alfred::ItemBuilder::new("Item 2")
                                .subtitle("Subtitle")
                                .into_item();
let item3 = alfred::ItemBuilder::new("Item 3")
                                .arg("Argument")
                                .subtitle("Subtitle")
                                .icon_filetype("public.folder")
                                .into_item();

try!(xmlw.write_item(&item1));
try!(xmlw.write_item(&item2));
try!(xmlw.write_item(&item3));

let mut stdout = try!(xmlw.close());
stdout.flush()

Re-exports

pub use self::xml::XMLWriter;

Modules

env	Accessors for workflow environment variables
json	Helpers for writing Alfred script filter JSON output (Alfred 3)
xml	Helpers for writing Alfred script filter XML output (Alfred 2)

Structs

Item	Representation of a script filter item.
ItemBuilder	Helper for building Item values.
ModifierData	Optional overrides of subtitle, arg, and valid for modifiers.

Enums

Icon	Item icons
ItemType	Item types
Modifier	Keyboard modifiers.