Struct EasyHttpWebClientBuilder 

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

Available on crate features http and http-full only.

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<T, Stage> EasyHttpWebClientBuilder<T, Stage>

pub fn with_custom_connector<L>( self, connector_layer: L, ) -> EasyHttpWebClientBuilder<L::Service, Stage>

where L: Layer<T>,

Add a custom connector to this Stage.

Adding a custom connector to a stage will not change the state so this can be used to modify behaviour at a specific stage.

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

Available on crate features rustls or boring only.

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>

Available on crate feature boring only.

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>

Available on crate feature boring only.

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>

Available on crate feature rustls only.

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>

Available on crate feature rustls only.

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>

Available on crate feature socks5 only.

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>

Available on crate feature socks5 only.

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<L::Service, TlsStage>

where L: Layer<T>,

Available on crate features rustls or boring only.

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

Note: when using a tls_connector you probably want to also add a RequestVersionAdapter which applies the negotiated http version from tls alpn. This can be achieved by using Self::with_custom_connector just after adding the tls connector.

pub fn with_tls_support_using_boringssl( self, config: Option<Arc<TlsConnectorDataBuilder>>, ) -> EasyHttpWebClientBuilder<RequestVersionAdapter<TlsConnector<T>>, TlsStage>

Available on crate feature boring only.

Support https connections by using boringssl for tls

Note: this also adds a RequestVersionAdapter to automatically change the request version to the one configured with tls alpn. If this is not wanted, use Self::with_custom_tls_connector instead.

pub fn with_tls_support_using_rustls( self, config: Option<TlsConnectorData>, ) -> EasyHttpWebClientBuilder<RequestVersionAdapter<TlsConnector<T>>, TlsStage>

Available on crate feature rustls only.

Support https connections by using ruslts for tls

Note: this also adds a RequestVersionAdapter to automatically change the request version to the one configured with tls alpn. If this is not wanted, use Self::with_custom_tls_connector instead.

pub fn without_tls_support(self) -> EasyHttpWebClientBuilder<T, TlsStage>

Dont support https on this connector

impl<T> EasyHttpWebClientBuilder<T, TlsStage>

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

Add http support to this connector

pub fn with_custom_http_connector<L>( self, connector_layer: L, ) -> EasyHttpWebClientBuilder<L::Service, HttpStage>

where L: Layer<T>,

Add a custom http connector that will be run just after tls

impl<T, I> EasyHttpWebClientBuilder<HttpConnector<T, I>, HttpStage>

pub fn with_svc_req_inspector<U>( self, http_req_inspector: U, ) -> EasyHttpWebClientBuilder<HttpConnector<T, U>, 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: StreamingBody<Data: Send + 'static, Error: Into<BoxError>> + Unpin + Send + 'static, ModifiedBody: StreamingBody<Data: Send + 'static, Error: Into<BoxError>> + Unpin + Send + 'static, T: Service<Request<Body>, Response = EstablishedClientConnection<ConnResponse, Request<ModifiedBody>>, Error = BoxError>, ConnResponse: ExtensionsMut,

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.