Struct Screen 

pub struct Screen { /* private fields */ }

A rendered Script Filter result screen.

Screen wraps the parsed JSON output from an Alfred workflow invocation, providing read-only accessors for inspecting items and their properties. When created by a Simulator, it also carries graph context for action routing.

Example

use alfrusco::simulator::Screen;

let json = r#"{"items":[{"title":"Hello","arg":"world","valid":true}]}"#;
let screen = Screen::from_json(json).unwrap();
assert_eq!(screen.items().len(), 1);
assert_eq!(screen.items()[0].title(), "Hello");
assert_eq!(screen.items()[0].arg(), Some("world"));
assert!(screen.items()[0].is_valid());

Implementations

impl Screen

pub fn from_json(json: &str) -> Result<Self, ScreenError>

Parses a JSON string (Alfred Script Filter output) into a Screen.

A Screen created this way has no graph context; Screen::action will return None. Use Simulator to get action-routable screens.

Errors

Returns an error if the JSON is invalid or missing the items array.

pub fn with_context(self, graph: Arc<WorkflowGraph>, source_uid: String) -> Self

Creates a screen with graph context for action routing.

This is useful for testing action resolution without a full Simulator setup — parse JSON via Screen::from_json, then attach a graph.

pub fn items(&self) -> &[ScreenItem]

Returns the items on this screen.

pub fn len(&self) -> usize

Returns the number of items on this screen.

pub fn is_empty(&self) -> bool

Returns true if there are no items on this screen.

pub fn raw_json(&self) -> &Value

Returns the raw JSON value of the entire response.

pub fn assert_renders(&self)

Asserts that this screen renders at least one item.

Panics

Panics if the screen has no items.

pub fn action(&self, index: usize) -> Option<ActionResult>

Determines the action result for the item at the given index.

Walks the workflow graph from the source Script Filter to determine what would happen if the user actioned this item (with the given modifier bitmask, defaulting to 0 for no modifiers).

Returns None if this screen has no graph context (created via Screen::from_json rather than a Simulator).

Panics

Panics if index is out of bounds.

pub fn action_first(&self) -> Option<ActionResult>

Determines the action result for the first item on this screen.

Convenience wrapper around Screen::action with index 0.

Returns None if this screen has no graph context or is empty.

pub fn action_with_modifiers( &self, index: usize, modifiers: u64, ) -> Option<ActionResult>

Determines the action result for the item at the given index with a specific modifier bitmask.

Alfred modifier bitmasks: Cmd=1048576, Alt=524288, Ctrl=262144, Shift=131072, Fn=8388608. Combine with bitwise OR.

Returns None if this screen has no graph context.

Panics

Panics if index is out of bounds.

Trait Implementations

impl Clone for Screen

fn clone(&self) -> Screen

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Screen

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

Formats the value using the given formatter.