Struct TlsConnector

pub struct TlsConnector<S, K = ConnectorKindAuto> { /* private fields */ }

A connector which can be used to establish a connection to a server.

By default it will created in auto mode (TlsConnector::auto), which will perform the Tls handshake on the underlying stream, only if the request requires a secure connection. You can instead use [TlsConnector::secure_only] to force the connector to always establish a secure connection.

Implementations

impl<S, K> TlsConnector<S, K>

pub const fn new(inner: S, kind: K) -> TlsConnector<S, K>

Creates a new TlsConnector.

pub fn with_connector_data( self, connector_data: TlsConnectorData, ) -> TlsConnector<S, K>

Attach TlsConnectorData to this TlsConnector, to be used instead of a globally shared [TlsConnectorData::default].

NOTE: for a smooth interaction with HTTP you most likely do want to create tls connector data to at the very least define the ALPN’s correctly.

E.g. if you create an auto client, you want to make sure your ALPN can handle all. It will be then also be the TlsConnector that sets the request http version correctly.

pub fn maybe_with_connector_data( self, connector_data: Option<TlsConnectorData>, ) -> TlsConnector<S, K>

Maybe attach TlsConnectorData to this TlsConnector, to be used if Some instead of a globally shared [TlsConnectorData::default].

pub fn set_connector_data( &mut self, connector_data: TlsConnectorData, ) -> &mut TlsConnector<S, K>

Attach TlsConnectorData to this TlsConnector, to be used instead of a globally shared default client config.

impl<S> TlsConnector<S>

pub fn auto(inner: S) -> TlsConnector<S>

Creates a new TlsConnector which will establish a secure connection if the request demands it, otherwise it will forward the pre-established inner connection.

impl<S> TlsConnector<S, ConnectorKindSecure>

pub fn secure(inner: S) -> TlsConnector<S, ConnectorKindSecure>

Creates a new TlsConnector which will always establish a secure connection regardless of the request it is for.

impl<S> TlsConnector<S, ConnectorKindTunnel>

pub fn tunnel( inner: S, host: Option<Host>, ) -> TlsConnector<S, ConnectorKindTunnel>

Creates a new TlsConnector which will establish a secure connection if the request is to be tunneled.

Trait Implementations

impl<S, K> Clone for TlsConnector<S, K>

where S: Clone, K: Clone,

fn clone(&self) -> TlsConnector<S, K>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<S, K> Debug for TlsConnector<S, K>

where S: Debug, K: Debug,

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

Formats the value using the given formatter.

impl<S, State, Request> Service<State, Request> for TlsConnector<S>

where S: ConnectorService<State, Request>, <S as ConnectorService<State, Request>>::Connection: Stream + Unpin, <S as ConnectorService<State, Request>>::Error: Into<Box<dyn Error + Sync + Send>>, State: Clone + Send + Sync + 'static, Request: TryRefIntoTransportContext<State> + Send + 'static, <Request as TryRefIntoTransportContext<State>>::Error: Into<Box<dyn Error + Sync + Send>> + Send + Sync + 'static,

type Response = EstablishedClientConnection<AutoTlsStream<<S as ConnectorService<State, Request>>::Connection>, State, Request>

The type of response returned by the service.

type Error = Box<dyn Error + Sync + Send>

The type of error returned by the service.

async fn serve( &self, ctx: Context<State>, req: Request, ) -> Result<<TlsConnector<S> as Service<State, Request>>::Response, <TlsConnector<S> as Service<State, Request>>::Error>

Serve a response or error for the given request, using the given context.

fn boxed(self) -> BoxService<S, Request, Self::Response, Self::Error>

Box this service to allow for dynamic dispatch.

impl<S, State, Request> Service<State, Request> for TlsConnector<S, ConnectorKindSecure>

where S: ConnectorService<State, Request>, <S as ConnectorService<State, Request>>::Connection: Stream + Unpin, <S as ConnectorService<State, Request>>::Error: Into<Box<dyn Error + Sync + Send>>, State: Clone + Send + Sync + 'static, Request: TryRefIntoTransportContext<State> + Send + 'static, <Request as TryRefIntoTransportContext<State>>::Error: Into<Box<dyn Error + Sync + Send>> + Send + Sync + 'static,

type Response = EstablishedClientConnection<TlsStream<<S as ConnectorService<State, Request>>::Connection>, State, Request>

The type of response returned by the service.

type Error = Box<dyn Error + Sync + Send>

The type of error returned by the service.

async fn serve( &self, ctx: Context<State>, req: Request, ) -> Result<<TlsConnector<S, ConnectorKindSecure> as Service<State, Request>>::Response, <TlsConnector<S, ConnectorKindSecure> as Service<State, Request>>::Error>

Serve a response or error for the given request, using the given context.

fn boxed(self) -> BoxService<S, Request, Self::Response, Self::Error>

Box this service to allow for dynamic dispatch.

impl<S, State, Request> Service<State, Request> for TlsConnector<S, ConnectorKindTunnel>

where S: ConnectorService<State, Request>, <S as ConnectorService<State, Request>>::Connection: Stream + Unpin, <S as ConnectorService<State, Request>>::Error: Into<Box<dyn Error + Sync + Send>>, State: Clone + Send + Sync + 'static, Request: Send + 'static,

type Response = EstablishedClientConnection<AutoTlsStream<<S as ConnectorService<State, Request>>::Connection>, State, Request>

The type of response returned by the service.

type Error = Box<dyn Error + Sync + Send>

The type of error returned by the service.

async fn serve( &self, ctx: Context<State>, req: Request, ) -> Result<<TlsConnector<S, ConnectorKindTunnel> as Service<State, Request>>::Response, <TlsConnector<S, ConnectorKindTunnel> as Service<State, Request>>::Error>

Serve a response or error for the given request, using the given context.

fn boxed(self) -> BoxService<S, Request, Self::Response, Self::Error>

Box this service to allow for dynamic dispatch.