Module alfred::json

Helpers for writing Alfred script filter JSON output (Alfred 3)

Examples

Writing items

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()
])

Writing items with variables

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())

Structs

Builder

A helper type for writing out items with top-level variables.

Functions

write_items

Writes a complete JSON document representing the Items to the Write.