Struct ark_api::storage::Store

pub struct Store { /* private fields */ }

Simple key-value data store for which all values are loaded at startup.

Prefer using AsyncStore for large data stores.

Implementations

impl Store

pub fn open(realm: StoreRealm, name: StoreName) -> Self

Open a store for a specific realm and name.

If the store doesn’t exist, locally or globally, it will be automatically created.

Names of stores is limited to max 32 characters and can only be alphanumeric or dash or underscore.

Global stores

Note that for StoreRealm::Global this can be a very expensive operation as it will synchronize and download latest data. Prefer to call this early in module initialization.

Also the store name is global, so be precise and unique in your naming to not pollute or collide other stores.

Panics

This function panics if a store could not be opened for the given name.

pub fn async_open(realm: StoreRealm, name: StoreName) -> OpenSyncStorePromise

Start opening a store for a specific realm and name.

If the store doesn’t exist, locally or globally, it will be automatically created.

Names of stores is limited to max 32 characters and can only be alphanumeric or dash or underscore.

Global stores

The store name is global, so be precise and unique in your naming to not pollute or collide other stores.

Panics

This function panics if a store could not be opened for the given name.

pub fn insert<K: AsRef<[u8]>, V: AsRef<[u8]>>(&mut self, key: K, value: V)

Insert a key

If the key already exists in the store, it will be overwritten

pub fn remove<K: AsRef<[u8]>>(&mut self, key: K)

Remove a key

pub fn keys(&self) -> Keys

Get a list of all keys currently in the store.

Note that this is a snapshot from the time of the call, for stores using StoreRealm::Global there is a chance keys can be removed while one is iterating through this list, and new keys can also be added or the value of the keys changed

This can be bit expensive operation for stores that contain a lot of keys

pub fn contains<K: AsRef<[u8]>>(&self, key: K) -> bool

Check if the store has a specific key

pub fn get<K: AsRef<[u8]>>(&self, key: K) -> Option<Vec<u8>>

Get the value of a key, if available

Trait Implementations

impl Clone for Store

fn clone(&self) -> Store

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Drop for Store

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq<Store> for Store

fn eq(&self, other: &Store) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Store