Struct Client 

pub struct Client { /* private fields */ }

Typed HTTP client built on reqwest.

Implementations

impl Client

pub fn new(base_url: impl AsRef<str>) -> Result<Client, Error>

Creates a client with default reqwest settings and the given base URL.

Examples

let client = Client::new("https://api.example.com")?;
let _ = client.get("/health").send().await?;

pub fn builder() -> ClientBuilder

Returns a ClientBuilder for advanced configuration.

pub fn with_http_client( reqwest_client: Client, base_url: impl AsRef<str>, ) -> Result<Client, Error>

Builds a client with a custom reqwest instance. ClientBuilder::base_url is required.

pub fn call<E>( &self, ) -> EndpointRequestBuilder<'_, E, <<E as Endpoint>::Params as EndpointParams>::BuilderState>

where E: Endpoint, <E as Endpoint>::Params: EndpointParamsInitial<E>,

Starts a typed request for Endpoint E.

When E::Params is not unit, returns a builder in NeedsParams state that requires .params() before .send_json().

For ad-hoc requests with string paths, use Self::get / Self::post instead.

Examples

define_params!(GetTodoParams for "/todos/:id" { id: u64 });

struct GetTodo;
impl Endpoint for GetTodo {
    const METHOD: http::Method = http::Method::GET;
    const PATH: &'static str = "/todos/:id";
    type Response = Todo;
    type Params = GetTodoParams;
    type Query = ();
}

let client = Client::new("https://api.example.com")?;
let todo = client
    .call::<GetTodo>()
    .params(GetTodoParams { id: 1 })
    .send_json()
    .await?;

pub fn config(&self) -> &ClientConfig

Returns a snapshot of this client’s configuration.

pub fn get(&self, path: impl Into<String>) -> RequestBuilder<'_>

Starts a GET request for path (supports :param templates).

pub fn post(&self, path: impl Into<String>) -> RequestBuilder<'_>

Starts a POST request for path.

pub fn put(&self, path: impl Into<String>) -> RequestBuilder<'_>

Starts a PUT request for path.

pub fn patch(&self, path: impl Into<String>) -> RequestBuilder<'_>

Starts a PATCH request for path.

pub fn delete(&self, path: impl Into<String>) -> RequestBuilder<'_>

Starts a DELETE request for path.

pub fn head(&self, path: impl Into<String>) -> RequestBuilder<'_>

Starts a HEAD request for path.

pub fn request( &self, method: Method, path: impl Into<String>, ) -> RequestBuilder<'_>

Starts a request with an explicit HTTP method and path.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.