Trait frame_support::traits::StoredMap

source · [−]
pub trait StoredMap<K, T: Default> {
    fn get(k: &K) -> T;

    fn try_mutate_exists<R, E: From<StoredMapError>>(
        k: &K, 
        f: impl FnOnce(&mut Option<T>) -> Result<R, E>
    ) -> Result<R, E>;

    fn mutate<R>(
        k: &K, 
        f: impl FnOnce(&mut T) -> R
    ) -> Result<R, StoredMapError> { ... }

    fn mutate_exists<R>(
        k: &K, 
        f: impl FnOnce(&mut Option<T>) -> R
    ) -> Result<R, StoredMapError> { ... }

    fn insert(k: &K, t: T) -> Result<(), StoredMapError> { ... }

    fn remove(k: &K) -> Result<(), StoredMapError> { ... }
}
Expand description

An abstraction of a value stored within storage, but possibly as part of a larger composite item.

Required methods

Get the item, or its default if it doesn’t yet exist; we make no distinction between the two.

Maybe mutate the item only if an Ok value is returned from f. Do nothing if an Err is returned. It is removed or reset to default value if it has been mutated to None

Provided methods

Mutate the item.

Mutate the item, removing or resetting to default value if it has been mutated to None.

This is infallible as long as the value does not get destroyed.

Set the item to something new.

Remove the item or otherwise replace it with its default value; we don’t care which.

Implementors