Expand description
Store Rust SDK Client.
Provides typed access to the store put/get/query APIs plus HTTP health/readiness probes.
§Errors
RPC failures surface as ClientError::Rpc carrying a native ConnectError. Use
ClientError::decoded_rpc_error or StoreClient::decode_error_details to unpack
protobuf google.rpc details (and store.query.v1.Detail on query RPC errors), not string parsing.
Idempotent reads honor google.rpc.RetryInfo when deciding backoff (see retry_delay_for_error).
Re-exports§
pub use keys::Key;pub use keys::KeyMut;pub use keys::KeyValidationError;pub use keys::Prefix;pub use keys::PrefixError;pub use keys::Value;pub use keys::MAX_KEY_LEN;pub use proto::*;
Modules§
- keys
- kv_
codec - proto
- Protobuf types and service stubs.
- prune_
policy - retention
- Sequence-log retention policy (the domain model behind
log.retention.v1.SetRetention). - selector
- Shared key-filter shape:
(prefix, payload_regex). - stream_
filter - Validated filter for
log.stream.v1.Subscribe.
Structs§
- Connect
Error - A ConnectRPC error.
- GetMany
Chunk - GetMany
Stream - Ingest
- Prefixed
Store Client - A physical
StoreClientpaired with aStoreKeyPrefixthat namespaces every key on the wire. The prefix can be the zero-widthStoreKeyPrefix::identity, representing the un-namespaced case. - Prune
- Query
- Range
Chunk - Range
Stream - Iterator-like async range stream.
- Retention
- Retry
Config - Retry policy for idempotent read operations.
- Serializable
Read Session - A session whose read floor advances to the highest Store sequence observed.
- Store
Client - Typed Rust client for Store.
- Store
Client Builder - Configures a
StoreClientwith explicit bases for health probes and store services. - Store
KeyPrefix - A client-side namespace layered over raw Store keys.
- Store
Write Batch - A physical Store write batch assembled from one or more logical clients.
- Stream
- Stream
Subscription - Async stream of
StreamSubscriptionFrame. Backed by the generated connectrpc server stream. - Stream
Subscription Entry - One delivered (key, value) row from a stream subscription. The client reapplies its own filter if it needs to know which selector matched — the wire frame doesn’t carry the index.
- Stream
Subscription Frame - One atomic Put batch delivered to a subscriber.
Enums§
- Client
Build Error - Error returned while building a
StoreClient. - Client
Error - Store client error.
- Connect
Request Compression - Codec used to compress outgoing RPC request bodies when compression applies.
- Error
Code - ConnectRPC error codes.
- Range
Mode - Traversal mode for range queries.
- Store
KeyPrefix Error - Errors returned by
StoreKeyPrefixwhen a logical key cannot be mapped into the prefixed physical keyspace.
Constants§
- API_
KEY_ ENV - Environment variable read for the API key when none is set on the builder.
Traits§
- Into
Store Write Value - Converts caller-provided write values into the byte owner stored by
StoreWriteBatch. - Store
Batch Upload - A writer that can stage an already-prepared upload into a shared Store write batch and then be notified of the batch outcome.
Functions§
- scalar_
reduce_ response - Returns the sole scalar frame after validating its shape and consuming the final status.
Type Aliases§
- Reduce
Stream - Final reduction results, delivered in bounded frames without collecting all groups.