Expand description
Authenticated Rust client for Keldra object storage.
The crate provides ready-to-use object, authorization, administration, and PersonalDB clients, upload helpers, and the complete generated protocol surface.
Modules§
Structs§
- Bearer
Token - Boolean
Field - A Boolean field supporting exact matching and facets.
- Date
Field - A timestamp field stored as signed Unix epoch milliseconds.
- Date
Format - Input and facet presentation format for a Date field.
- Float
Field - Index
Order Token - An order declaration that can only be obtained from a single-valued field
carrying the
ORDERcapability. - Keyword
Field - An uninterpreted UTF-8 field with binary UTF-8 collation.
- Predicate
Expression - One valid, bounded public Boolean predicate expression.
- Signed
Integer Field - Text
Field - An analyzed UTF-8 field. Analysis must be selected before full-text search.
- Typed
Json Index Builder - Builds one complete Typed JSON index definition.
- Unsigned
Integer Field
Enums§
- Index
Definition Error - A definition rejected before a request is sent to Keldra.
- Predicate
Build Error - A predicate rejected locally before a request is sent to Keldra.
- Predicate
Scalar - One canonical JSON scalar accepted by a Typed JSON or metadata predicate.
Functions§
- administration_
client - authz_
client - connect
- connect_
channel - Opens the shared transport used by object, PersonalDB, authorization and administration clients. Keeping credential exchange separate makes the one unauthenticated RPC explicit at call sites.
- connect_
with_ credentials - Convenience for callers that want an object client directly from durable credentials. Long-lived applications should repeat exchange when their short-lived token expires, not persist the returned bearer token forever.
- exchange_
client_ credentials - Exchanges one durable application credential for a short-lived bearer token. Production endpoints must be protected by TLS; the client secret is sent only in this request and is never retained by this transport.
- index_
client - object_
client - personaldb_
client - put_
chunks - Executes the public StartPut + Put + PutEnd flow for owned chunks. Empty input sends the required single empty chunk and therefore creates a valid zero-byte object. This helper is for already-owned, infallible input; a fallible file or network producer must cancel the in-flight RPC on source failure so a short read cannot become a clean end-of-stream publication.