Struct StoreState

pub struct StoreState(/* private fields */);

Internal state of a store.

Implementations

impl StoreState

pub fn new() -> StoreState

Creates an empty StoreState.

pub fn with_capacity(capacity: usize) -> StoreState

Creates an empty StoreState with at least the specified capacity.

pub fn into_inner(self) -> HashMap<String, Value>

Consumes the StoreState and returns the inner HashMap.

pub fn get(&self, key: impl AsRef<str>) -> Option<&Value>

Gets a reference to the value corresponding to the key.

pub fn get_mut(&mut self, key: impl AsRef<str>) -> Option<&mut Value>

Gets a mutable reference to the value corresponding to the key.

pub fn try_get<T>(&self, key: impl AsRef<str>) -> Result<T, Error>

where T: DeserializeOwned,

Gets a value and tries to parse it as an instance of type T.

pub fn try_get_or<T>(&self, key: impl AsRef<str>, default: T) -> T

where T: DeserializeOwned,

Gets a value and tries to parse it as an instance of type T.

If it does not exist, returns the provided default value.

pub fn try_get_or_default<T>(&self, key: impl AsRef<str>) -> T

where T: DeserializeOwned + Default,

Gets a value and tries to parse it as an instance of type T.

If it does not exist, returns the default value of T.

pub fn try_get_or_else<T>( &self, key: impl AsRef<str>, f: impl FnOnce() -> T, ) -> T

where T: DeserializeOwned,

Gets a value and tries to parse it as an instance of type T.

If it does not exist, returns the result of the provided closure.

pub fn set( &mut self, key: impl AsRef<str>, value: impl Into<Value>, ) -> Option<Value>

Sets a key-value pair, returning the previous value, if any.

pub fn patch(&mut self, state: impl Into<StoreState>)

Patches the state.

pub fn has(&self, key: impl AsRef<str>) -> bool

Whether a key exists.

pub fn keys(&self) -> impl Iterator<Item = &String>

Creates an iterator over the keys.

pub fn values(&self) -> impl Iterator<Item = &Value>

Creates an iterator over the values.

pub fn values_mut(&mut self) -> impl Iterator<Item = &mut Value>

Creates an iterator over mutable references to the values.

pub fn entries(&self) -> impl Iterator<Item = (&String, &Value)>

Creates an iterator over the entries.

pub fn entries_mut(&mut self) -> impl Iterator<Item = (&String, &mut Value)>

Creates an iterator over mutable references to the entries.

pub fn remove(&mut self, key: impl AsRef<str>) -> Option<Value>

Removes a key, returning the previous value, if any.

pub fn retain<F>(&mut self, f: F)

where F: FnMut(&String, &mut Value) -> bool,

Retains only the values specified by the predicate.

pub fn clear(&mut self)

Clears the store state, removing all key-value pairs.

pub fn len(&self) -> usize

Returns the amount of items.

pub fn is_empty(&self) -> bool

Whether it is empty.

Trait Implementations

impl Clone for StoreState

fn clone(&self) -> StoreState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StoreState

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

Formats the value using the given formatter.

impl Default for StoreState

fn default() -> StoreState

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StoreState

fn deserialize<D>( deserializer: D, ) -> Result<StoreState, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const N: usize, K, V> From<[(K, V); N]> for StoreState

where K: Into<String>, V: Into<Value>,

fn from(pairs: [(K, V); N]) -> StoreState

Converts to this type from the input type.

impl<K, V> From<(K, V)> for StoreState

where K: Into<String>, V: Into<Value>,

fn from(_: (K, V)) -> StoreState

Converts to this type from the input type.

impl From<HashMap<String, Value>> for StoreState

fn from(map: HashMap<String, Value>) -> StoreState

Converts to this type from the input type.

impl<K, V> From<Vec<(K, V)>> for StoreState

where K: Into<String>, V: Into<Value>,

fn from(pairs: Vec<(K, V)>) -> StoreState

Converts to this type from the input type.

impl<K, V> FromIterator<(K, V)> for StoreState

where K: Into<String>, V: Into<Value>,

fn from_iter<I>(iter: I) -> StoreState

where I: IntoIterator<Item = (K, V)>,

Creates a value from an iterator.

impl Serialize for StoreState

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.