Struct ActionsFile 

pub struct ActionsFile { /* private fields */ }

A store file as read: each entry’s JSON, untouched.

Implementations

impl ActionsFile

pub fn parse(text: &str) -> Result<ActionsFile>

Parses the file’s text. Entries that are not objects are refused, as is anything but an array.

pub fn to_text(&self) -> String

The text falcon writes.

pub fn load(path: &Path) -> Result<ActionsFile>

Reads a store file; a missing file is an empty list.

pub fn save(&self, path: &Path) -> Result<()>

Writes a store file atomically: a temp file beside it, then a rename, creating its folder if needed. On a failure the temp file is removed and the old file, if any, stays as it was.

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn actions(&self) -> Vec<ActionDef>

The actions, in file order.

pub fn put(&mut self, def: &ActionDef)

Adds an action at the end, or replaces the entry with its id. Only id, name, shortcut and steps are written; the entry’s other fields and its key order stay.

pub fn set_shortcut(&mut self, id: &str, shortcut: Option<String>)

Changes only an action’s shortcut (also for an entry falcon can’t run).

pub fn remove(&mut self, id: &str)

Removes an action.

pub fn duplicate(&mut self, id: &str, name: &str) -> Option<String>

A copy of the action right after it, with a new id and name. Returns the new id.

pub fn reorder(&mut self, id: &str, to: usize)

Moves an action to to (an index in the list after its removal).

Trait Implementations

impl Clone for ActionsFile

fn clone(&self) -> ActionsFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ActionsFile

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

Formats the value using the given formatter.

impl Default for ActionsFile

fn default() -> ActionsFile

Returns the “default value” for a type.

impl PartialEq for ActionsFile

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ActionsFile