Struct Output 

pub struct Output { /* private fields */ }

The Alfred script filter workflow output.

A script filter is required to return zero or more Items. Each Item describes a result row displayed in Alfred. The three obvious elements are the ones you see in an Alfred result row - Item::new, Item::subtitle and Item::icon.

Implementations

impl Output

pub fn new() -> Self

Create a new output.

pub fn rerun(&mut self, duration: Duration) -> &mut Self

Set the rerun value.

Scripts can be set to re-run automatically after an interval with a value of 0.1 to 5.0 seconds. The script will only be re-run if the script filter is still active and the user hasn’t changed the state of the filter by typing and triggering a re-run.

pub fn skip_knowledge(&mut self, skip_knowledge: bool) -> &mut Self

Set the skip knowledge value.

This allows you to set uid and preserve the item order while allowing Alfred to retain knowledge of your items, like your current selection during a re-run.

pub fn variables<K, V>( self, variables: impl IntoIterator<Item = (K, V)>, ) -> Self

where K: Into<String>, V: Into<String>,

Set the variables which are passed out of the script filter object.

These remain accessible throughout the current session as environment variables. In addition, they are passed back in when the script reruns within the same session. This can be used for managing state between runs as the user types input or when the script is set to re-run after an interval.

These can be overridden on a per-item or per-modifier basis. See Item::variables and Modifier::variables.

pub fn cache(&mut self, cache: Cache) -> &mut Self

Set the cache settings for this output.

pub fn items<I>(&mut self, iter: I) -> &mut Self

where I: IntoIterator<Item = Item>,

Extend the list of items to output.

pub fn write<W: Write>(&self, w: W) -> Result<()>

Output this script filter to the given writer.

Trait Implementations

impl Clone for Output

fn clone(&self) -> Output

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Output

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

Formats the value using the given formatter.

impl Default for Output

fn default() -> Output

Returns the “default value” for a type.

impl PartialEq for Output

fn eq(&self, other: &Output) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Output

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Output

impl StructuralPartialEq for Output