Struct worker_kv::KvStore

pub struct KvStore { /* fields omitted */ }

A binding to a Cloudflare KvStore.

Implementations

impl KvStore

pub fn create(binding: &str) -> Result<Self, KvError>

Creates a new KvStore with the binding specified in your wrangler.toml.

pub fn from_this(this: &JsValue, binding: &str) -> Result<Self, KvError>

Creates a new KvStore with the binding specified in your wrangler.toml, using an alternative this value for arbitrary binding contexts.

pub async fn get(&self, name: &str) -> Result<Option<KvValue>, KvError>

Fetches the value from the kv store by name.

pub async fn get_with_metadata<M: DeserializeOwned>(
    &self,
    name: &str
) -> Result<Option<(KvValue, M)>, KvError>

Fetches the value and associated metadata from the kv store by name.

pub fn put<T: ToRawKvValue>(
    &self,
    name: &str,
    value: T
) -> Result<PutOptionsBuilder, KvError>

Puts data into the kv store.

pub fn put_bytes(
    &self,
    name: &str,
    value: &[u8]
) -> Result<PutOptionsBuilder, KvError>

Puts the specified byte slice into the kv store.

pub fn list(&self) -> ListOptionsBuilder

Lists the keys in the kv store.

pub async fn delete(&self, name: &str) -> Result<(), KvError>

Deletes a key in the kv store.

Trait Implementations

impl Clone for KvStore

fn clone(&self) -> KvStore

Returns a copy of the value.

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

Performs copy-assignment from source.