Struct Client 

pub struct Client { /* private fields */ }

A pooled HTTP client.

Cloning is cheap and shares the connection pool, so build one per process and clone it into whatever needs it. Building one per request would open a fresh connection every time, which is the single most common way to make an outbound call slow.

Implementations

impl Client

pub fn new() -> Self

A client with pooled connections, a 30 second timeout, a 16 MiB response ceiling, and redirect following up to 10 hops.

pub fn timeout(self, d: Duration) -> Self

Fail a request that has not finished after d.

The deadline covers the whole request including redirects, not each hop, so a redirect chain cannot multiply the time a caller waits.

pub fn max_response_bytes(self, bytes: usize) -> Self

Refuse a response body larger than bytes.

The ceiling applies to the payload the caller sees: after transparent decompression when that is enabled, so a compressed response cannot expand past this limit either.

pub fn max_redirects(self, n: usize) -> Self

Follow at most n redirects. Zero returns the redirect response itself.

pub fn auto_decompress(self, enabled: bool) -> Self

Advertise and decode gzip / deflate response bodies.

Enabled by default. Set to false to leave Content-Encoding bodies untouched and stop sending Accept-Encoding.

pub fn user_agent(self, value: &str) -> Result<Self, ClientError>

Replace the User-Agent sent with every request.

Errors

If the value is not a valid header value.

pub fn default_header( self, name: &str, value: &str, ) -> Result<Self, ClientError>

Send a header with every request from this client.

Errors

If the name or value is not valid.

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

Start a request with an arbitrary method.

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

Start a GET.

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

Start a POST.

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

Start a PUT.

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

Start a PATCH.

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

Start a DELETE.

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

Start a HEAD.

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.

impl Debug for Client

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

Formats the value using the given formatter.

impl Default for Client

fn default() -> Self

Returns the “default value” for a type.