Struct ClientBuilder 

pub struct ClientBuilder { /* private fields */ }

Builds a Client.

Implementations

impl ClientBuilder

pub fn new() -> Self

A builder with the defaults: no client-level timeout, a DEFAULT_MAX_RESPONSE_BYTES read limit, DEFAULT_MAX_REDIRECTS.

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

Bound a whole request, body included.

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

Bound connection setup.

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

Bound each idle read, so a long streamed body is not cut while it keeps arriving.

pub fn user_agent(self, user_agent: &str) -> Self

Send user_agent on every request.

pub fn default_headers(self, headers: HeaderMap) -> Self

Send headers on every request.

pub fn proxy(self, url: &str) -> Self

Route every request through the proxy at url. A malformed URL fails build.

pub fn no_proxy(self) -> Self

Ignore proxy environment variables.

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

Follow at most n redirects (0 returns the redirect response).

pub fn max_response_bytes(self, limit: Option<u64>) -> Self

Refuse a buffered body above limit bytes; None lifts the limit.

pub fn reference_policy(self, policy: Arc<ReferencePolicy>) -> Self

Check the first request and every redirect hop send follows against policy, instead of the one scoped over the task (with_reference_policy).

pub fn sensitive_header(self, name: &str) -> Self

Drop the header name on a redirect to another origin, like Authorization. Name every header that carries a credential (an API key, a session id). An invalid name fails build.

pub fn configure(self, f: impl FnOnce(ClientBuilder) -> ClientBuilder) -> Self

Set any other reqwest option: |b| b.gzip(true), an identity, root certificates. Don’t set a redirect policy here — redirects are followed by Client::send, which strips credentials on a cross-origin hop.

pub fn try_configure( self, f: impl FnOnce(ClientBuilder) -> Result<ClientBuilder, FaucetError>, ) -> Result<Self, FaucetError>

Like configure for a step that can fail.

pub fn build_reqwest(self) -> Result<Client, FaucetError>

Build a plain reqwest::Client with these settings, for a connector whose public API already hands out a reqwest client. It follows same-origin redirects only; prefer build, which also follows cross-origin hops safely and bounds reads.

pub fn build(self) -> Result<Client, FaucetError>

Build the client.

Trait Implementations

impl Debug for ClientBuilder

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

Formats the value using the given formatter.

impl Default for ClientBuilder

fn default() -> Self

Returns the “default value” for a type.