Struct KvStoreApiClient 

pub struct KvStoreApiClient { /* private fields */ }

Client for the QuickNode Key-Value Store. Supports two primitives: sets (single string values under a key) and lists (ordered collections of strings under a key).

Implementations

impl KvStoreApiClient

pub fn new(config: SdkConfig) -> Self

pub async fn create_set(&self, params: &CreateSetParams) -> Result<(), SdkError>

Creates a new set, storing a single string value under the given key.

pub async fn get_sets( &self, params: &GetSetsParams, ) -> Result<GetSetsResponse, SdkError>

Returns a paginated page of key/value entries from the store. Use the response cursor to fetch subsequent pages.

pub async fn get_set(&self, key: &str) -> Result<GetSetResponse, SdkError>

Returns the string value stored for a single set by key.

pub async fn bulk_sets(&self, params: &BulkSetsParams) -> Result<(), SdkError>

Adds and removes multiple sets in a single request. Either add_sets, delete_sets, or both may be supplied.

pub async fn delete_set(&self, key: &str) -> Result<(), SdkError>

Removes a single set by key.

pub async fn create_list( &self, params: &CreateListParams, ) -> Result<(), SdkError>

Creates a new list under the given key, seeded with the provided items.

pub async fn get_lists( &self, params: &GetListsParams, ) -> Result<GetListsResponse, SdkError>

Returns a paginated page of list keys from the store. Use the response cursor to fetch subsequent pages.

pub async fn get_list( &self, key: &str, params: &GetListParams, ) -> Result<GetListResponse, SdkError>

Returns a paginated page of items from the list identified by key. Use the response cursor to fetch subsequent pages.

pub async fn update_list( &self, key: &str, params: &UpdateListParams, ) -> Result<(), SdkError>

Updates an existing list by adding and/or removing items in a single operation. Either add_items, remove_items, or both may be supplied.

pub async fn add_list_item( &self, key: &str, params: &AddListItemParams, ) -> Result<(), SdkError>

Appends a single item to the list identified by key.

pub async fn list_contains_item( &self, key: &str, item: &str, ) -> Result<ListContainsItemResponse, SdkError>

Checks whether the specified list contains the given item.

pub async fn delete_list_item( &self, key: &str, item: &str, ) -> Result<(), SdkError>

Removes a specific item from the list identified by key.

pub async fn delete_list(&self, key: &str) -> Result<(), SdkError>

Removes a list and all of its items by key.

Trait Implementations

impl Clone for KvStoreApiClient

fn clone(&self) -> KvStoreApiClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KvStoreApiClient

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

Formats the value using the given formatter.