Struct spin_sdk::key_value::Store

pub struct Store { /* private fields */ }

An open key-value store

Implementations

impl Store

pub fn open_default() -> Result<Self, Error>

Open the default store.

This is equivalent to Store::open("default").

impl Store

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

Serialize the given data to JSON, then set it as the value for the specified key.

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

Deserialize an instance of type T from the value of key.

impl Store

pub fn open(label: &str) -> Result<Store, Error>

Open the store with the specified label.

label must refer to a store allowed in the spin.toml manifest.

error::no-such-store will be raised if the label is not recognized.

impl Store

pub fn get(&self, key: &str) -> Result<Option<Vec<u8>>, Error>

Get the value associated with the specified key

Returns ok(none) if the key does not exist.

impl Store

pub fn set(&self, key: &str, value: &[u8]) -> Result<(), Error>

Set the value associated with the specified key overwriting any existing value.

impl Store

pub fn delete(&self, key: &str) -> Result<(), Error>

Delete the tuple with the specified key

No error is raised if a tuple did not previously exist for key.

impl Store

pub fn exists(&self, key: &str) -> Result<bool, Error>

Return whether a tuple exists for the specified key

impl Store

pub fn get_keys(&self) -> Result<Vec<String>, Error>

Return a list of all the keys

Trait Implementations

impl Debug for Store

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

Formats the value using the given formatter.

impl WasmResource for Store

unsafe fn drop(handle: u32)

Invokes the [resource-drop]... intrinsic.