Struct StoreHandle 

pub struct StoreHandle { /* private fields */ }

A handle to a key-value store that is open for lookups and inserting.

Implementations

impl StoreHandle

pub fn as_u32(&self) -> u32

Get the underlying representation of the handle.

This should only be used when calling the raw ABI directly, and care should be taken not to reuse or alias handle values.

pub fn open(name: &str) -> Result<Option<StoreHandle>, KVStoreError>

Open a handle to the KV Store with the given name.

pub fn lookup( &self, key: impl AsRef<[u8]>, ) -> Result<PendingLookupHandle, KVStoreError>

Look up a value in the KV Store.

Returns Ok(PendingLookupHandle) if the creation of the async request was successful.

pub fn pending_lookup_wait( &self, pending_lookup_handle: PendingLookupHandle, ) -> Result<LookupResponse, KVStoreError>

Wait on the async lookup of a value in the KV Store.

Returns Ok(LookupResponse) if a value is found, and Err(KVStoreError) if an error has occurred.

pub fn insert( &self, key: impl AsRef<str>, value: BodyHandle, mode: InsertMode, background_fetch: bool, if_generation_match: Option<u64>, metadata: impl AsRef<str>, time_to_live_sec: Option<Duration>, ) -> Result<PendingInsertHandle, KVStoreError>

Insert a value into the KV Store.

If the KV Store already contains a value for this key, it will be overwritten.

pub fn pending_insert_wait( &self, pending_insert_handle: PendingInsertHandle, ) -> Result<(), KVStoreError>

Wait on the async insert of a value in the KV Store.

Returns Ok(()) if insert is a success, and KVStoreError on failure

pub fn delete( &self, key: impl AsRef<str>, ) -> Result<PendingDeleteHandle, KVStoreError>

Create async delete of a value in the KV Store.

Returns Ok(PendingDeleteHandle) if the creation of the async request was successful.

pub fn pending_delete_wait( &self, pending_delete_handle: PendingDeleteHandle, ) -> Result<(), KVStoreError>

Wait on the async delete of a value in the KV Store.

Returns Ok(()) if delete is a success, and KVStoreError on failure

pub fn list( &self, mode: ListMode, cursor: Option<String>, limit: Option<u32>, prefix: Option<String>, ) -> Result<PendingListHandle, KVStoreError>

Create async list of keys in the KV Store.

Returns Ok(PendingListHandle) if the creation of the async request was successful.

pub fn pending_list_wait( &self, pending_list_handle: PendingListHandle, ) -> Result<ListResponse<'_>, KVStoreError>

Wait on the async list of keys in the KV Store.

Returns Ok(ListResponse) if the request was successful

Trait Implementations

impl Debug for StoreHandle

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

Formats the value using the given formatter.

impl Eq for StoreHandle

impl Hash for StoreHandle

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for StoreHandle

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for StoreHandle