Struct JsonFileStore 

pub struct JsonFileStore { /* private fields */ }

A file-backed store that persists state across restarts.

Uses atomic file rename to prevent corruption on crash: every write serialises to a .tmp file first, then renames it over the target path.

Suitable for single-process bot operators. For multi-process or high-throughput use cases, see RocksDbStore (v0.2).

Example

use xenith_sync::JsonFileStore;
use xenith_core::StateStore;

let store = JsonFileStore::new("/tmp/xenith-state.json")?;

Implementations

impl JsonFileStore

pub fn new(path: impl Into<PathBuf>) -> Result<Self>

Open or create a JSON file store at path.

If the file exists it is parsed on construction. If it does not exist an empty store is initialised (the file is created on the first write).

Trait Implementations

impl StateStore for JsonFileStore

fn get<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 StateKey, ) -> Pin<Box<dyn Future<Output = Result<Option<StateValue>>> + Send + 'async_trait>>

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

Retrieve the value for key, or None if it has not been set.

fn set<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 StateKey, value: StateValue, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

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

Insert or overwrite the value for key.

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

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

Remove the value for key. No-op if the key does not exist.

fn list_prefix<'life0, 'life1, 'async_trait>( &'life0 self, prefix: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<StateKey>>> + Send + 'async_trait>>

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

Return all keys whose string representation starts with prefix.

fn get_metadata<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 StateKey, ) -> Pin<Box<dyn Future<Output = Result<Option<KeyMetadata>>> + Send + 'async_trait>>

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

Retrieve the KeyMetadata for key, or None if not set.

fn set_metadata<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 StateKey, meta: KeyMetadata, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

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

Store KeyMetadata for key.