Struct KeyValue 

pub struct KeyValue<Effect, Event> { /* private fields */ }

Implementations

impl<Effect, Event> KeyValue<Effect, Event>

where Effect: Send + From<Request<KeyValueOperation>> + 'static, Event: Send + 'static,

pub fn get( key: impl Into<String>, ) -> RequestBuilder<Effect, Event, impl Future<Output = DataResult>>

Read a value under key

pub fn set( key: impl Into<String>, value: Vec<u8>, ) -> RequestBuilder<Effect, Event, impl Future<Output = DataResult>>

Set key to be the provided value. Typically the bytes would be a value serialized/deserialized by the app.

pub fn delete( key: impl Into<String>, ) -> RequestBuilder<Effect, Event, impl Future<Output = DataResult>>

Remove a key and its value, return previous value if it existed

pub fn exists( key: impl Into<String>, ) -> RequestBuilder<Effect, Event, impl Future<Output = StatusResult>>

Check to see if a key exists

pub fn list_keys( prefix: impl Into<String>, cursor: u64, ) -> RequestBuilder<Effect, Event, impl Future<Output = ListResult>>

List keys that start with the provided prefix, starting from the provided cursor.

A cursor is an opaque value that points to the first key in the next page of keys.

If the cursor is not found for the specified prefix, the response will include a KeyValueError::CursorNotFound error.

If the cursor is found the result will be a tuple of the keys and the next cursor (if there are more keys to list, the cursor will be non-zero, otherwise it will be zero)