Skip to main content

ClientBuilder

Struct ClientBuilder 

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

Builder for constructing a Client with custom configuration.

Implementations§

Source§

impl ClientBuilder

Source

pub fn new() -> Self

Create a new builder with defaults (30s timeout, 3 retries, exponential backoff).

Source

pub fn base_url(self, url: impl Into<String>) -> Self

Set a base URL that is prepended to all relative paths.

Source

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

Set the request timeout.

Source

pub fn retries(self, retries: u32) -> Self

Set the maximum number of retries.

Shapes the built-in middleware::RetryMiddleware (feature retry, default-on). For custom retry behavior, register a middleware::RetryMiddleware with a full middleware::RetryConfig via ClientBuilder::with_middleware.

Source

pub fn retry_bounds(self, initial: Duration, max: Duration) -> Self

Set the initial and maximum retry backoff durations.

Source

pub fn with_middleware(self, middleware: impl Middleware) -> Self

Register custom middleware to run outermost — wrapping the built-in retry/breaker stack — observing each logical request once.

Middleware registered first runs outermost; see the middleware module docs for the full ordering semantics.

Source

pub fn default_header(self, key: &'static str, value: &'static str) -> Self

Add a default header applied to every request (infallible for compile-time string literals).

§Panics

Panics if key or value is not a valid HTTP header string — this is a caller programming error, not a runtime condition. Use default_headers with a HeaderMap for a fallible variant.

Source

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

Set multiple default headers applied to every request.

Source

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

Set the User-Agent header.

Source

pub fn reqwest_builder(self, builder: ClientBuilder) -> Self

Add a raw reqwest::ClientBuilder for advanced configuration.

Source

pub fn build(self) -> Client

Build the Client.

§Panics

Panics if the underlying reqwest::Client cannot be built. This should only happen due to process-startup defects (e.g. invalid TLS config), not from user input at runtime.

Source

pub fn try_build(self) -> Result<Client, FetchError>

Build the Client, returning a FetchError on failure.

Trait Implementations§

Source§

impl Default for ClientBuilder

Source§

fn default() -> Self

Returns the “default value” for a type. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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: Sized + 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: Sized + 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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