Struct Client 

pub struct Client { /* private fields */ }

A connection to one FeltDB server. Cheap to clone; clones share the connection pool and token.

Implementations

impl Client

pub async fn capabilities(&self) -> Result<Value>

The server’s versioned capability declaration.

impl Client

pub async fn get(&self, collection: &str, id: &str) -> Result<Option<Record>>

The record collection/id, or None if it does not exist.

pub async fn list(&self, collection: &str) -> Result<Vec<Record>>

Every record of collection. This reads the whole collection: on a request path use Client::query, which is bounded.

pub async fn create( &self, collection: &str, id: Option<&str>, value: Value, ) -> Result<Record>

Create a record only if id is free; refused with HTTP 409 if it exists. value must be a JSON object. Without an id, the server assigns one.

pub async fn update( &self, collection: &str, id: &str, changes: Map<String, Value>, ) -> Result<Record>

Merge changes into an existing record (unconditionally). Refused with HTTP 404 if the record does not exist; use a Transaction or Client::compare_and_set to fence it.

pub async fn delete(&self, collection: &str, id: &str) -> Result<()>

Delete an existing record. Refused with HTTP 404 if it does not exist.

pub async fn compare_and_set( &self, collection: &str, id: &str, request: &CasRequest, ) -> Result<CasOutcome>

Replace a record if it still has the version (and epoch and lease) you read.

pub async fn commit(&self, transaction: &Transaction) -> Result<CommitReceipt>

Commit a transaction atomically. A refusal applied nothing; a failed precondition or fence is reported in Error::precondition_failure.

pub async fn read_basis(&self, reads: &ReadSet) -> Result<ReadBasis>

Capture what the authority holds for reads, to fence a later transaction on it.

pub async fn query(&self, query: &BoundedQuery) -> Result<QueryPage>

Run one page of a bounded query.

pub async fn revision(&self) -> Result<Revision>

The authority’s committed revision.

pub async fn events(&self, cursor: Option<&str>) -> Result<EventStream>

Committed changes as they happen, from cursor (a previous event’s id) or from now.

impl Client

pub async fn health(&self) -> Result<Health>

The server’s health report. Unauthenticated on the server.

pub fn control(&self) -> Control

The control plane: tenants, applications, contract drafts, revisions, promotion, backup.

impl Client

pub fn builder(url: impl Into<String>) -> ClientBuilder

Start configuring a client for the server at url, e.g. http://127.0.0.1:7700.

pub fn url(&self) -> &str

The server URL, without a trailing slash.

pub fn set_token(&self, token: impl Into<String>)

Replace the bearer token (or clear it with an empty string) for this client and its clones.

pub fn application(&self, application_id: impl Into<String>) -> Application

A handle on one application’s canonical Service API, in its production environment unless Application::environment says otherwise.

pub async fn request<B: Serialize + ?Sized>( &self, method: Method, path: &str, body: Option<&B>, ) -> Result<Value>

Any server route, for what this client does not name. path starts with / and may carry a query string. An empty success (204) is Value::Null.

pub async fn request_with_headers<B: Serialize + ?Sized>( &self, method: Method, path: &str, headers: &[(&str, &str)], body: Option<&B>, ) -> Result<Value>

Client::request with extra headers, e.g. a route’s if-version precondition.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.