Struct KvClient 

pub struct KvClient { /* private fields */ }

Client for KV operations.

Implementations

impl KvClient

pub fn max_decoding_message_size(self, limit: usize) -> Self

Limits the maximum size of a decoded message.

Default: 4MB

pub fn max_encoding_message_size(self, limit: usize) -> Self

Limits the maximum size of an encoded message.

Default: usize::MAX

pub async fn put( &mut self, key: impl Into<Vec<u8>>, value: impl Into<Vec<u8>>, options: Option<PutOptions>, ) -> Result<PutResponse, Error>

Puts the given key into the key-value store. A put request increments the revision of the key-value store and generates one event in the event history.

pub async fn get( &mut self, key: impl Into<Vec<u8>>, options: Option<GetOptions>, ) -> Result<GetResponse, Error>

Gets the key or a range of keys from the store.

pub async fn get_stream( &mut self, key: impl Into<Vec<u8>>, options: Option<GetOptions>, ) -> Result<GetStreamResponse, Error>

The streaming version of get, which was introduced in etcd v3.7. It returns the same result as get, but the server splits the response into a sequence of chunks and streams them to the client. This avoids buffering large ranges entirely in memory on either side.

Field population across chunks:

• Kvs - each chunk carries a disjoint slice of the result. Concatenating the kvs from every chunk in the order they arrive yields the same key set as a single Range call (KvClient::get).
• Header, More, Count - populated only on the final chunk, and only when the stream completes without error. Earlier chunks leave these fields zero-valued.

Read RangeStream for more details.

pub async fn delete( &mut self, key: impl Into<Vec<u8>>, options: Option<DeleteOptions>, ) -> Result<DeleteResponse, Error>

Deletes the given key or a range of keys from the key-value store.

pub async fn compact( &mut self, revision: i64, options: Option<CompactionOptions>, ) -> Result<CompactionResponse, Error>

Compacts the event history in the etcd key-value store. The key-value store should be periodically compacted or the event history will continue to grow indefinitely.

pub async fn txn(&mut self, txn: Txn) -> Result<TxnResponse, Error>

Processes multiple operations in a single transaction. A txn request increments the revision of the key-value store and generates events with the same revision for every completed operation. It is not allowed to modify the same key several times within one txn.

Trait Implementations

impl Clone for KvClient

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.