Struct EasyHttpWebClientBuilder

pub struct EasyHttpWebClientBuilder<C = (), S = ()> { /* private fields */ }

Builder that is designed to easily create a super::EasyHttpWebClient from most basic use cases

Implementations

impl EasyHttpWebClientBuilder

pub fn new() -> Self

pub fn with_default_transport_connector( self, ) -> EasyHttpWebClientBuilder<TcpConnector, TransportStage>

pub fn with_custom_transport_connector<C>( self, connector: C, ) -> EasyHttpWebClientBuilder<C, TransportStage>

Add a custom transport connector that will be used by this client for the transport layer

impl EasyHttpWebClientBuilder<TcpConnector, TransportStage>

pub fn with_dns_resolver<T: DnsResolver + Clone>( self, resolver: T, ) -> EasyHttpWebClientBuilder<TcpConnector<T>, TransportStage>

Add a custom DnsResolver that will be used by this client

impl<T> EasyHttpWebClientBuilder<T, TransportStage>

pub fn with_custom_tls_proxy_connector<L>( self, connector_layer: L, ) -> EasyHttpWebClientBuilder<L::Service, ProxyTunnelStage>

where L: Layer<T>,

Add a custom proxy tls connector that will be used to setup a tls connection to the proxy

pub fn with_tls_proxy_support_using_boringssl( self, ) -> EasyHttpWebClientBuilder<TlsConnector<T, ConnectorKindTunnel>, ProxyTunnelStage>

Support a tls tunnel to the proxy itself using boringssl

Note that a tls proxy is not needed to make a https connection to the final target. It only has an influence on the initial connection to the proxy itself

pub fn with_tls_proxy_support_using_boringssl_config( self, config: Arc<TlsConnectorDataBuilder>, ) -> EasyHttpWebClientBuilder<TlsConnector<T, ConnectorKindTunnel>, ProxyTunnelStage>

Support a tls tunnel to the proxy itself using boringssl and the provided config

Note that a tls proxy is not needed to make a https connection to the final target. It only has an influence on the initial connection to the proxy itself

pub fn with_tls_proxy_support_using_rustls( self, ) -> EasyHttpWebClientBuilder<TlsConnector<T, ConnectorKindTunnel>, ProxyTunnelStage>

Support a tls tunnel to the proxy itself using rustls

Note that a tls proxy is not needed to make a https connection to the final target. It only has an influence on the initial connection to the proxy itself

pub fn with_tls_proxy_support_using_rustls_config( self, config: TlsConnectorData, ) -> EasyHttpWebClientBuilder<TlsConnector<T, ConnectorKindTunnel>, ProxyTunnelStage>

Support a tls tunnel to the proxy itself using rustls and the provided config

Note that a tls proxy is not needed to make a https connection to the final target. It only has an influence on the initial connection to the proxy itself

pub fn without_tls_proxy_support( self, ) -> EasyHttpWebClientBuilder<T, ProxyTunnelStage>

Don’t support a tls tunnel to the proxy itself

Note that a tls proxy is not needed to make a https connection to the final target. It only has an influence on the initial connection to the proxy itself

impl<T> EasyHttpWebClientBuilder<T, ProxyTunnelStage>

pub fn with_custom_proxy_connector<L>( self, connector_layer: L, ) -> EasyHttpWebClientBuilder<L::Service, ProxyStage>

where L: Layer<T>,

Add a custom proxy connector that will be used by this client

pub fn with_proxy_support( self, ) -> EasyHttpWebClientBuilder<ProxyConnector<Arc<T>>, ProxyStage>

Add support for usage of a http(s) and socks5(h) ProxyAddress to this client

Note that a tls proxy is not needed to make a https connection to the final target. It only has an influence on the initial connection to the proxy itself

pub fn with_http_proxy_support( self, ) -> EasyHttpWebClientBuilder<HttpProxyConnector<T>, ProxyStage>

Add support for usage of a http(s) ProxyAddress to this client

Note that a tls proxy is not needed to make a https connection to the final target. It only has an influence on the initial connection to the proxy itself

pub fn with_socks5_proxy_support( self, ) -> EasyHttpWebClientBuilder<Socks5ProxyConnector<T>, ProxyStage>

Add support for usage of a socks5(h) ProxyAddress to this client

pub fn without_proxy_support(self) -> EasyHttpWebClientBuilder<T, ProxyStage>

Make a client without proxy support

impl<T> EasyHttpWebClientBuilder<T, ProxyStage>

pub fn with_custom_tls_connector<L>( self, connector_layer: L, ) -> EasyHttpWebClientBuilder<HttpConnector<L::Service, (HttpsAlpnModifier, HttpVersionAdapter)>, HttpStage>

where L: Layer<T>,

Add a custom tls connector that will be used by the client

This will also add the HttpsAlpnModifier request inspector as that one is crucial to make tls alpn work and set the correct TargetHttpVersion

And a HttpVersionAdapter that will adapt the request version to the configured TargetHttpVersion

If you don’t want any of these inspector you can use Self::with_advanced_jit_req_inspector to configure your own request inspectors or Self::without_jit_req_inspector to remove all the default request inspectors

pub fn with_tls_support_using_boringssl( self, config: Option<Arc<TlsConnectorDataBuilder>>, ) -> EasyHttpWebClientBuilder<HttpConnector<TlsConnector<T>, (HttpsAlpnModifier, HttpVersionAdapter)>, HttpStage>

Support https connections by using boringssl for tls

This will also add the HttpsAlpnModifier request inspector as that one is crucial to make tls alpn work and set the correct TargetHttpVersion

And a HttpVersionAdapter that will adapt the request version to the configured TargetHttpVersion

If you don’t want any of these inspector you can use Self::with_advanced_jit_req_inspector to configure your own request inspectors or Self::without_jit_req_inspector to remove all the default request inspectors

pub fn with_tls_support_using_rustls( self, config: Option<TlsConnectorData>, ) -> EasyHttpWebClientBuilder<HttpConnector<TlsConnector<T>, (HttpsAlpnModifier, HttpVersionAdapter)>, HttpStage>

Support https connections by using ruslts for tls

This will also add the HttpsAlpnModifier request inspector as that one is crucial to make tls alpn work and set the correct TargetHttpVersion

And a HttpVersionAdapter that will adapt the request version to the configured TargetHttpVersion

If you don’t want any of these inspector you can use Self::with_advanced_jit_req_inspector to configure your own request inspectors or Self::without_jit_req_inspector to remove all the default request inspectors

pub fn without_tls_support( self, ) -> EasyHttpWebClientBuilder<HttpConnector<T, HttpVersionAdapter>, HttpStage>

Dont support https on this connector

This will also add the HttpVersionAdapter that will adapt the request version to the configured TargetHttpVersion

If you don’t want any of these inspector you can use Self::with_advanced_jit_req_inspector to configure your own request inspectors or Self::without_jit_req_inspector to remove all the default request inspectors

impl<T, I1, I2> EasyHttpWebClientBuilder<HttpConnector<T, I1, I2>, HttpStage>

pub fn with_advanced_jit_req_inspector<I>( self, http_req_inspector: I, ) -> EasyHttpWebClientBuilder<HttpConnector<T, I, I2>, HttpStage>

Add a http request inspector that will run just after the inner http connector has connected but before the http handshake happens

This function doesn’t add any default request inspectors

pub fn without_jit_req_inspector( self, ) -> EasyHttpWebClientBuilder<HttpConnector<T, (), I2>, HttpStage>

Removes the currently configured request inspector(s)

By default most methods add some request inspectors, this can be used to remove them

pub fn with_jit_req_inspector<I>( self, http_req_inspector: I, ) -> EasyHttpWebClientBuilder<HttpConnector<T, (HttpsAlpnModifier, HttpVersionAdapter, I), I2>, HttpStage>

Add a http request inspector that will run just after the inner http connector has connected but before the http handshake happens

This will also add the HttpsAlpnModifier request inspector as that one is crucial to make tls alpn work and set the correct TargetHttpVersion

And a HttpVersionAdapter that will adapt the request version to the configured TargetHttpVersion

If you don’t want any of these inspector you can use Self::with_advanced_jit_req_inspector to configure your own request inspectors without any defaults

pub fn with_svc_req_inspector<I>( self, http_req_inspector: I, ) -> EasyHttpWebClientBuilder<HttpConnector<T, I1, I>, HttpStage>

Add a http request inspector that will run just before doing the actual http request

impl<T> EasyHttpWebClientBuilder<T, HttpStage>

pub fn with_connection_pool<C>( self, config: HttpPooledConnectorConfig, ) -> Result<EasyHttpWebClientBuilder<PooledConnector<T, LruDropPool<C, BasicHttpConId>, BasicHttpConnIdentifier>, PoolStage>, OpaqueError>

Use the default connection pool for this super::EasyHttpWebClient

This will create a LruDropPool using the provided limits and will use BasicHttpConnIdentifier to group connection on protocol and authority, which should cover most common use cases

Use wait_for_pool_timeout to limit how long we wait for the pool to give us a connection

If you need a different pool or custom way to group connection you can use EasyHttpWebClientBuilder::with_custom_connection_pool() to provide you own.

pub fn with_custom_connection_pool<P, R>( self, pool: P, req_to_conn_id: R, wait_for_pool_timeout: Option<Duration>, ) -> EasyHttpWebClientBuilder<PooledConnector<T, P, R>, PoolStage>

Configure this client to use the provided Pool and ReqToConnId

Use wait_for_pool_timeout to limit how long we wait for the pool to give us a connection

impl<T, S> EasyHttpWebClientBuilder<T, S>

pub fn build<Body, ModifiedBody, ConnResponse>( self, ) -> EasyHttpWebClient<Body, T::Response>

where Body: Body<Data: Send + 'static, Error: Into<BoxError>> + Unpin + Send + 'static, ModifiedBody: Body<Data: Send + 'static, Error: Into<BoxError>> + Unpin + Send + 'static, T: Service<Request<Body>, Response = EstablishedClientConnection<ConnResponse, Request<ModifiedBody>>, Error = BoxError>,

Build a super::EasyHttpWebClient using the provided config

Trait Implementations

impl<C: Default, S: Default> Default for EasyHttpWebClientBuilder<C, S>

fn default() -> EasyHttpWebClientBuilder<C, S>

Returns the “default value” for a type.