Struct GrpcKvClient

Source

pub struct GrpcKvClient { /* private fields */ }

Expand description

gRPC-based key-value store client

Implements remote CRUD operations via gRPC protocol. All write operations use strong consistency.

Implementations§

Source §

impl GrpcKvClient

Source

pub async fn put( &self, key: impl AsRef<[u8]>, value: impl AsRef<[u8]>, ) -> Result<(), ClientApiError>

Stores a value with strong consistency

§Errors

crate::ClientApiError::Network on network failures
crate::ClientApiError::Protocol for protocol errors
crate::ClientApiError::Storage for server-side storage errors

Source

pub async fn put_with_ttl( &self, key: impl AsRef<[u8]>, value: impl AsRef<[u8]>, ttl_secs: u64, ) -> Result<(), ClientApiError>

Stores a value with TTL (time-to-live) and strong consistency

Key will automatically expire and be deleted after ttl_secs seconds.

§Arguments

key - The key to store
value - The value to store
ttl_secs - Time-to-live in seconds

§Errors

crate::ClientApiError::Network on network failures
crate::ClientApiError::Protocol for protocol errors
crate::ClientApiError::Storage for server-side storage errors

Source

pub async fn delete(&self, key: impl AsRef<[u8]>) -> Result<(), ClientApiError>

Deletes a key with strong consistency guarantees

Permanently removes the specified key and its associated value from the store.

§Parameters

key: The byte-serialized key to delete. Supports any type implementing AsRef<[u8]> (e.g. String, &str, Vec<u8>)

§Errors

crate::ClientApiError::Network if unable to reach the leader node
crate::ClientApiError::Protocol for protocol errors
crate::ClientApiError::Storage for server-side storage errors

Source

pub async fn get_linearizable( &self, key: impl AsRef<[u8]>, ) -> Result<Option<ClientResult>, ClientApiError>

Source

pub async fn get_lease( &self, key: impl AsRef<[u8]>, ) -> Result<Option<ClientResult>, ClientApiError>

Source

pub async fn get_eventual( &self, key: impl AsRef<[u8]>, ) -> Result<Option<ClientResult>, ClientApiError>

Source

pub async fn get( &self, key: impl AsRef<[u8]>, ) -> Result<Option<ClientResult>, ClientApiError>

Retrieves a single key’s value using server’s default consistency policy

Uses the cluster’s configured default consistency policy as defined in the server’s ReadConsistencyConfig.default_policy setting.

§Parameters

key - The key to retrieve, accepts any type implementing AsRef<[u8]>

§Returns

Ok(Some(ClientResult)) - Key exists, returns key-value pair
Ok(None) - Key does not exist in the store
Err(ClientApiError) - Read failed due to network or consistency issues

Source

pub async fn get_with_policy( &self, key: impl AsRef<[u8]>, consistency_policy: Option<ReadConsistencyPolicy>, ) -> Result<Option<ClientResult>, ClientApiError>

Retrieves a single key’s value with explicit consistency policy

Allows client to override server’s default consistency policy for this specific request. If server’s allow_client_override is false, the override will be ignored.

§Parameters

key - The key to retrieve, accepts any type implementing AsRef<[u8]>
policy - Explicit consistency policy for this request

Source

pub async fn get_multi( &self, keys: impl IntoIterator<Item = impl AsRef<[u8]>>, ) -> Result<Vec<Option<ClientResult>>, ClientApiError>

Fetches multiple keys using server’s default consistency policy

Uses the cluster’s configured default consistency policy as defined in the server’s ReadConsistencyConfig.default_policy setting.

Source

pub async fn get_multi_with_policy( &self, keys: impl IntoIterator<Item = impl AsRef<[u8]>>, consistency_policy: Option<ReadConsistencyPolicy>, ) -> Result<Vec<Option<ClientResult>>, ClientApiError>

Fetches multiple keys with explicit consistency policy override

Allows client to override server’s default consistency policy for this batch request. If server’s allow_client_override is false, the override will be ignored.

Source

pub async fn watch( &self, key: impl AsRef<[u8]>, ) -> Result<Streaming<WatchResponse>, ClientApiError>

Watch for changes on a specific key

Returns a stream of watch events whenever the specified key is modified (PUT or DELETE). The stream will continue until the client drops the receiver or disconnects.

§Arguments

key - The exact key to watch (prefix/range watch not supported in v1)

§Returns

Ok(Streaming<WatchResponse>) - Stream of watch events
Err(ClientApiError) - If watch feature is disabled or connection fails

§Example

use futures::StreamExt;

let mut stream = client.kv().watch("my_key").await?;
while let Some(event) = stream.next().await {
    match event {
        Ok(response) => println!("Key changed: {:?}", response),
        Err(e) => eprintln!("Watch error: {:?}", e),
    }
}