Struct Request 

pub struct Request<T, E> { /* private fields */ }

The one request builder: a method, a path and its query, an optional JSON body, the Authenticator that signs it and the Costs it charges the client’s throttle.

send runs it on HttpClient::send, decodes the body as T, and turns an unsuccessful response into E.

Implementations

impl<T, E> Request<T, E>

pub fn new(http_client: HttpClient, path: impl Into<String>) -> Self

Create a new GET request

pub fn method(self, method: Method) -> Self

Send with method instead of GET.

pub fn authenticator(self, auth: Arc<DynAuthenticator<'static>>) -> Self

Sign every attempt with auth.

pub fn with_cost(self, cost: Cost) -> Self

Charge the client’s throttle cost for every attempt, as well as whatever its request-counting layers charge.

impl<T, E: From<ApiError>> Request<T, E>

pub fn body<B: Serialize + ?Sized>(self, body: &B) -> Result<Self, E>

Send body as JSON, with Content-Type: application/json.

The body is serialised once, here, through serde_json::Value, so every attempt sends, and an authenticator signs, the same bytes. A Value sorts an object’s keys, so those bytes need not follow the struct’s field order.

Errors

ApiError::Serialization when body does not serialise.

impl<T: DeserializeOwned, E: RequestError> Request<T, E>

pub async fn send(self) -> Result<T, E>

Execute the request and deserialize response

pub async fn send_raw(self) -> Result<Response, E>

Execute the request and return raw response

It runs on HttpClient::send, so it is throttled, gated, signed, retried and held by the client’s hooks. A response that is not a 2xx is never returned: it reaches E as ApiError::Response.

Trait Implementations

impl<T, E> Clone for Request<T, E>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, E> QueryBuilder for Request<T, E>

fn add_query(&mut self, key: String, value: String)

Append a query parameter in place. Implementor hook for the builder methods below.

fn query(self, key: impl Into<String>, value: impl ToString) -> Self

Append a query parameter and return self for chaining.

fn query_opt(self, key: impl Into<String>, value: Option<impl ToString>) -> Self

Add optional query parameter (only if Some)

fn query_many<I, V>(self, key: impl Into<String>, values: I) -> Self

where I: IntoIterator<Item = V>, V: ToString,

Add multiple query parameters with the same key

fn query_many_opt<I, V>(self, key: impl Into<String>, values: Option<I>) -> Self

where I: IntoIterator<Item = V>, V: ToString,

Add multiple optional query parameters with the same key