Struct awc::ClientBuilder

pub struct ClientBuilder<S = (), M = ()> { /* 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(
) -> ClientBuilder<impl Service<ConnectInfo<Uri>, Response = TcpConnection<Uri, TcpStream>, Error = TcpConnectError> + Clone, ()>

impl<S, Io, M> ClientBuilder<S, M> where
    S: Service<ConnectInfo<Uri>, Response = TcpConnection<Uri, Io>, Error = TcpConnectError> + Clone + 'static,
    Io: ActixStream + Debug + 'static, 

pub fn connector<S1, Io1>(
    self,
    connector: Connector<S1>
) -> ClientBuilder<S1, M> where
    S1: Service<ConnectInfo<Uri>, Response = TcpConnection<Uri, Io1>, Error = TcpConnectError> + Clone + 'static,
    Io1: ActixStream + Debug + 'static, 

Use custom connector service.

pub fn timeout(self, timeout: Duration) -> 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 local_address(self, addr: IpAddr) -> Self

Set local IP Address the connector would use for establishing connection.

pub fn max_http_version(self, val: Version) -> Self

Maximum supported HTTP major version.

Supported versions are HTTP/1.1 and HTTP/2.

pub fn disable_redirects(self) -> Self

Do not follow redirects.

Redirects are allowed by default.

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

Set max number of redirects.

Max redirects is set to 10 by default.

pub fn initial_window_size(self, size: u32) -> Self

Indicates the initial window size (in octets) for HTTP2 stream-level flow control for received data.

The default value is 65,535 and is good for APIs, but not for big objects.

pub fn initial_connection_window_size(self, size: u32) -> Self

Indicates the initial window size (in octets) for HTTP2 connection-level flow control for received data.

The default value is 65,535 and is good for APIs, but not for big objects.

pub fn no_default_headers(self) -> Self

Do not add fundamental default request headers.

By default Date and User-Agent headers are set.

pub fn add_default_header(self, header: impl TryIntoHeaderPair) -> Self

Add default header.

Headers added by this method get added to every request unless overriden by .

Panics

Panics if header name or value is invalid.

pub fn basic_auth<N>(self, username: N, password: Option<&str>) -> Self where
    N: 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 wrap<S1, M1>(
    self,
    mw: M1
) -> ClientBuilder<S, NestTransform<M, M1, S1, ConnectRequest>> where
    M: Transform<S1, ConnectRequest>,
    M1: Transform<M::Transform, ConnectRequest>, 

Registers middleware, in the form of a middleware component (type), that runs during inbound and/or outbound processing in the request life-cycle (request -> response), modifying request/response as necessary, across all requests managed by the Client.

pub fn finish(self) -> Client where
    M: Transform<DefaultConnector<ConnectorServicePriv<TcpConnectorService<TcpConnectorInnerService<S>>, Rc<dyn Service<Connect, Response = (Box<dyn ConnectionIo>, Protocol), Error = ConnectError, Future = LocalBoxFuture<'static, Result<(Box<dyn ConnectionIo>, Protocol), ConnectError>>>>, Io, Box<dyn ConnectionIo>>>, ConnectRequest> + 'static,
    M::Transform: Service<ConnectRequest, Response = ConnectResponse, Error = SendRequestError>, 

Finish build process and create Client instance.