Struct StoreClient 

pub struct StoreClient { /* private fields */ }

Typed Rust client for Store.

Implementations

impl StoreClient

pub fn builder() -> StoreClientBuilder

Start building a client with per-service base URLs.

pub fn new(url: &str) -> Self

pub fn with_retry_config(url: &str, retry_config: RetryConfig) -> Self

pub fn with_split_urls( health_base: &str, ingest_base: &str, query_base: &str, compact_base: &str, ) -> Self

Split endpoints for deployments where services run on different ports or hosts.

pub fn with_split_urls_and_retry( health_base: &str, ingest_base: &str, query_base: &str, compact_base: &str, retry_config: RetryConfig, ) -> Self

pub fn key_prefix(&self) -> Option<StoreKeyPrefix>

Return this client’s configured Store key prefix, if any.

pub fn with_key_prefix(&self, prefix: StoreKeyPrefix) -> Self

Clone this client with a client-side Store key prefix.

pub fn without_key_prefix(&self) -> Self

Clone this client without client-side key prefixing.

pub fn encode_store_key(&self, key: &Key) -> Result<Key, ClientError>

Encode a logical key as it will appear in the physical Store.

pub fn decode_store_key(&self, key: &Key) -> Result<Key, ClientError>

Decode a physical Store key into this client’s logical keyspace.

pub fn connect_request_compression(&self) -> ConnectRequestCompression

Outgoing Connect request body compression (see ConnectRequestCompression).

pub fn decode_error_details( err: &ConnectError, ) -> Result<DecodedConnectError, DecodeError>

pub fn create_session(&self) -> SerializableReadSession

Create an unseeded serializable read session.

The first successful unary read fixes the session’s sequence floor from the server response. Streamed query reads fix that floor only once their trailers arrive.

pub fn create_session_with_sequence( &self, sequence: u64, ) -> SerializableReadSession

Create a serializable read session pinned to at least sequence.

This is intended for stream-driven read paths that already observed a concrete store batch sequence and need follow-up query/proof reads to see at least that sequence.

pub fn ingest(&self) -> Ingest<'_>

Typed access to the store.ingest.v1 service.

pub fn query(&self) -> Query<'_>

Typed access to the store.query.v1 service.

pub fn compact(&self) -> Compact<'_>

Typed access to the store.compact.v1 service.

pub fn stream(&self) -> Stream<'_>

Typed access to the store.stream.v1 service.

pub async fn health(&self) -> Result<bool, ClientError>

pub async fn ready(&self) -> Result<bool, ClientError>

Trait Implementations

impl Clone for StoreClient

fn clone(&self) -> StoreClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StoreClient

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

Formats the value using the given formatter.