Skip to main content

ClientBuilder

Struct ClientBuilder 

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

Builder for Client.

Implementations§

Source§

impl ClientBuilder

Source

pub fn new() -> Self

Source

pub fn base_url(self, base_url: impl AsRef<str>) -> Result<Self>

Source

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

Source

pub fn retry(self, policy: RetryPolicy) -> Self

Source

pub fn auth(self, auth: Auth) -> Self

Source

pub fn default_header( self, key: impl AsRef<str>, value: impl AsRef<str>, ) -> Result<Self>

Source

pub fn hooks(self, hooks: Hooks) -> Self

Source

pub fn plugin<P: Plugin + 'static>(self, plugin: P) -> Self

Source

pub fn reqwest_client(self, client: ReqwestClient) -> Self

Source

pub fn backend(self, backend: Arc<dyn HttpBackend>) -> Self

Use a custom HTTP backend (for testing or alternate transports).

Source

pub fn max_in_flight(self, limit: usize) -> Self

Limits how many requests this client may have in flight at once (including retries).

Implemented with a tokio semaphore in the core client; does not require the tower feature. For token-bucket rate limiting or richer policies, use [Self::transport_stack] with Tower layers (feature tower).

Source

pub fn json_parser<F>(self, f: F) -> Self
where F: Fn(&Bytes) -> Result<Value, String> + Send + Sync + 'static,

Sets a custom JSON parser for all responses from this client.

The parser receives raw response bytes and must return a serde_json::Value. Typed deserialization (json, send_json) then uses serde to map that value to T.

Source

pub fn json_parser_fn(self, parser: JsonParserFn) -> Self

Sets a custom JSON parser from an existing JsonParserFn.

Source

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

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<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: 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: 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<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