Struct ntex::http::client::ClientBuilder

pub struct ClientBuilder { /* fields omitted */ }

An HTTP Client builder

This type can be used to construct an instance of Client through a builder-like pattern.

Implementations

impl ClientBuilder

pub fn new() -> Self

pub fn connector<T>(self, connector: T) -> Self where
    T: Service<Connect, Response = Connection, Error = ConnectError> + 'static, 

Use custom connector service.

pub fn timeout<T: Into<Millis>>(self, timeout: T) -> Self

Set request timeout.

Request timeout is the total time before a response must be received. Default value is 5 seconds.

pub fn disable_timeout(self) -> Self

Disable request timeout.

pub fn disable_redirects(self) -> Self

Do not follow redirects.

Redirects are allowed by default.

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

Set max number of redirects.

Max redirects is set to 10 by default.

pub fn no_default_headers(self) -> Self

Do not add default request headers. By default Date and User-Agent headers are set.

pub fn header<K, V>(self, key: K, value: V) -> Self where
    HeaderName: TryFrom<K>,
    HeaderValue: TryFrom<V>,
    <HeaderName as TryFrom<K>>::Error: Debug + Into<HttpError>,
    <HeaderValue as TryFrom<V>>::Error: Debug + Into<HttpError>, 

Add default header. Headers added by this method get added to every request.

pub fn basic_auth<U>(self, username: U, password: Option<&str>) -> Self where
    U: Display, 

Set client wide HTTP basic authorization header

pub fn bearer_auth<T>(self, token: T) -> Self where
    T: Display, 

Set client wide HTTP bearer authentication header

pub fn finish(self) -> Client

Finish build process and create Client instance.

Trait Implementations

impl Default for ClientBuilder

fn default() -> Self

Returns the “default value” for a type.