Struct SafirStore 

pub struct SafirStore {
    pub store: PersistentStore,
    pub headless: bool,
}

Safir Store (fancy wrapper around reading and writing to a JSON file)

Fields

store: PersistentStore

headless: bool

Implementations

impl SafirStore

pub async fn new(config: &SafirConfig) -> Result<Self>

Initialises the Safirstore if not already initialised

pub fn display_all(&self)

Display all key/values in the store

pub fn purge(&self)

Remove the store directory and all contents

Trait Implementations

impl SafirEngine for SafirStore

fn add_entry<'life0, 'async_trait>( &'life0 mut self, key: String, value: String, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Add an entry to the store and write it out to disk

fn get_entry<'life0, 'async_trait>( &'life0 self, key: String, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get an entry form the store by loading it from disk and displaying it

fn remove_entry<'life0, 'async_trait>( &'life0 mut self, keys: Vec<String>, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Remove a key/value pair from the store and update onto disk

fn set_commands<'life0, 'life1, 'life2, 'async_trait>( &'life0 mut self, prefix: &'life1 str, keys: &'life2 Vec<String>, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Outputs the key/value pair as a command with the prefix

E.g. With a prefix of alias this will display the command as alias {key}="{value}" with {key} / {value} replaced with their values from the store

fn clear_entries<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Clear the the contents of the store and update onto disk

fn to_type(&self) -> &dyn Any