Struct ClientBuilder 

pub struct ClientBuilder<M = Identity> { /* private fields */ }

An HTTP client builder.

This type configures connectors and middleware before constructing a Client.

Implementations

impl ClientBuilder<Identity>

pub fn new() -> Self

Creates a client builder with default connectors.

impl<M> ClientBuilder<M>

pub fn openssl(self, config: OpensslConnector) -> Self

Uses an OpenSSL connector for secure connections.

pub fn rustls(self, config: RustlsClientConfig) -> Self

Uses a rustls connector for secure connections.

pub fn connector<T>( self, f: impl IntoService<T, SharedCfg, TcpConnect<Url>>, ) -> Self

where T: Service<SharedCfg, TcpConnect<Url>, Error = Error<ConnectError>> + 'static, IoBoxed: From<T::Res>,

Uses a custom connector for unsecured connections.

pub fn secure_connector<T>( self, f: impl IntoService<T, SharedCfg, TcpConnect<Url>>, ) -> Self

where T: Service<SharedCfg, TcpConnect<Url>, Error = Error<ConnectError>> + 'static, IoBoxed: From<T::Res>,

Uses a custom connector for secure connections.

pub fn middleware<U>(self, mw: U) -> ClientBuilder<Stack<U, M>>

Applies middleware to the client request service.

Middleware can inspect or modify every request and response.

use ntex::client::{Client, ServiceRequest};
use ntex::service::{fn_layer, cfg::SharedCfg};

#[ntex::main]
async fn main() {
    let client = Client::builder()
        .middleware(fn_layer(
            async move |mut req: ServiceRequest, svc| {
                println!("{:?}", req.head().uri);
                svc.call(req).await
            }
        ))
        .build(SharedCfg::default());
}

pub fn build(self, cfg: impl Into<SharedCfg>) -> Client

where M: Middleware<Sender, SharedCfg>, M::Service: Service<SharedCfg, ServiceRequest, Res = ServiceResponse, Error = Error<ClientError>> + 'static,

Builds the Client using the supplied shared configuration.

Add a ClientConfig to SharedCfg to customize client behavior:

use ntex::SharedCfg;
use ntex::client::{Client, ClientConfig};
use ntex::time::Millis;

#[ntex::main]
async fn main() {
    let cfg = SharedCfg::new("HTTP-CLIENT")
        .add(
            ClientConfig::new()
                .set_response_timeout(Millis(10_000))
                .set_response_payload_limit(1024 * 1024),
        )
        .build();

    let _client = Client::builder().build(cfg);
}

Trait Implementations

impl<M: Debug> Debug for ClientBuilder<M>

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

Formats the value using the given formatter.

impl Default for ClientBuilder<Identity>

fn default() -> Self

Returns the “default value” for a type.