Struct StateStore 

pub struct StateStore { /* private fields */ }

State store for multiple params

Implementations

impl StateStore

pub fn new() -> Self

Create a new state store with default (unlimited) config

pub fn with_config(config: StateStoreConfig) -> Self

Create a new state store with the specified config

pub fn config(&self) -> &StateStoreConfig

Get the current configuration

pub fn get(&self, address: &str) -> Option<&ParamState>

Get a param’s current state (does not update last_accessed)

pub fn get_mut(&mut self, address: &str) -> Option<&mut ParamState>

Get a param’s current state and update last_accessed

pub fn get_value(&self, address: &str) -> Option<&Value>

Get a param’s current value (does not update last_accessed)

pub fn get_value_mut(&mut self, address: &str) -> Option<&Value>

Get a param’s current value and update last_accessed

pub fn set( &mut self, address: &str, value: Value, writer: &str, revision: Option<u64>, lock: bool, unlock: bool, ) -> Result<u64, UpdateError>

Set a param value, creating if necessary

pub fn cleanup_stale(&mut self, ttl: Duration) -> usize

Remove params that haven’t been accessed within the TTL Returns the number of params removed

pub fn cleanup_stale_with_config(&mut self) -> usize

Run cleanup using the configured TTL (if any) Returns the number of params removed

pub fn get_matching(&self, pattern: &str) -> Vec<(&str, &ParamState)>

Get all params matching a pattern

pub fn snapshot(&self) -> Vec<(&str, &ParamState)>

Get all params as a snapshot

pub fn len(&self) -> usize

Number of params

pub fn is_empty(&self) -> bool

Check if empty

pub fn remove(&mut self, address: &str) -> Option<ParamState>

Remove a param

pub fn clear(&mut self)

Clear all params

Trait Implementations

impl Debug for StateStore

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

Formats the value using the given formatter.

impl Default for StateStore

fn default() -> Self

Returns the “default value” for a type.