Skip to main content

Client

Struct Client 

Source
pub struct Client { /* private fields */ }
Expand description

HTTP client with the bearer token baked into its default headers.

Cheap to clone (it’s a thin wrapper around reqwest::Client, which is itself an Arc internally), so prefer cloning over re-building.

Implementations§

Source§

impl Client

Source

pub fn new(base_url: impl Into<String>, token: Token) -> Result<Self>

Build a client for the given platform base URL, authenticated with token. The base URL’s trailing slash (if any) is stripped.

Source

pub fn base_url(&self) -> &str

Base URL the client was configured with, with any trailing slash stripped. Useful for callers that want to print a clickable link alongside an API result ({base_url}/projects/…).

Source

pub async fn get_json<T: DeserializeOwned>(&self, path: &str) -> Result<T>

GET {path} and decode the JSON response.

Source

pub async fn get_json_query<T: DeserializeOwned, Q: Serialize + ?Sized>( &self, path: &str, query: &Q, ) -> Result<T>

GET {path}?query and decode the JSON response. query is any serde::Serialize — typically a &[(K, V)] or a struct.

Source

pub async fn post_json<T: DeserializeOwned, B: Serialize + ?Sized>( &self, path: &str, body: &B, ) -> Result<T>

POST {path} with body serialized as JSON, decode the JSON response.

Source

pub async fn post_empty(&self, path: &str) -> Result<()>

POST {path} with no body, expecting an empty/ignored response.

Source

pub async fn post_empty_returning_json<T: DeserializeOwned>( &self, path: &str, ) -> Result<T>

POST {path} with no body, decoding the JSON response. The CLI uses this for …/finalize endpoints that take no body but return the updated row.

Source

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

DELETE {path}.

Source

pub async fn put_proxy_bytes(&self, path: &str, body: Vec<u8>) -> Result<()>

PUT {path} with body as application/octet-stream. Used by the CLI’s models push to ship bytes through the platform’s proxy upload route when R2 isn’t directly reachable.

Source

pub async fn put_presigned_bytes( presigned_url: &str, body: Vec<u8>, ) -> Result<()>

PUT raw bytes to a presigned URL. Deliberately uses a fresh reqwest::Client (no auth headers) — adding Authorization: Bearer … would make S3/R2 reject the request because it’s not part of the SigV4 query-string signature.

Source

pub async fn get_stream_to<W: AsyncWriteExt + Unpin>( &self, path: &str, sink: &mut W, ) -> Result<u64>

Stream a GET response body into sink. Returns the number of bytes written. Used for big payloads (manifests, audio clips) where holding the whole body in memory would be wasteful.

Source§

impl Client

Source

pub async fn whoami(&self) -> Result<Me>

Fetch the signed-in user from /api/me. The canonical way to verify a freshly-minted token is reachable.

Source

pub async fn revoke_current_token(&self) -> Result<()>

Revoke the bearer token this client is using. After this returns successfully, the same token will start producing 401s — drop the Client (and clear whatever storage held the token).

Source§

impl Client

Source

pub async fn sync<E: SyncEndpoint>( &self, items: &[E::Record], ) -> Result<SyncResponse>

POST /api/voice/{E::RESOURCE}/sync — idempotent batch upload.

The platform upserts keyed by (user_id, item.source_id), so retries after a flaky connection are safe.

Batch size. The platform rejects batches over 100 items with HTTP 413. This method does not chunk for you — pass a slice you’re confident about, or use the daemon’s Uploader<E> which chunks at 50.

Schema version. Records whose envelope leaves schemaVersion unset (the common case — consumers don’t need to know the number) have it stamped with SyncEndpoint::CURRENT_SCHEMA_VERSION before serialization, so the platform always sees an explicit version. Records that set it explicitly are passed through untouched.

Source

pub async fn list<E: SyncEndpoint>( &self, query: &E::Query, ) -> Result<Page<E::Record>>

GET /api/voice/{E::RESOURCE} — one page of the caller’s rows, newest first, scoped server-side to the bearer’s user.

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more