Skip to main content

TlsConnector

rama::tls::boring::client

Struct TlsConnector

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

Available on crate feature boring only.

Expand description

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 to force the connector to always establish a secure connection.

Implementations§

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

pub fn maybe_with_base_config( self, base: Option<TlsClientConfig>, ) -> TlsConnector<S, K>

Set the base TlsClientConfig for this connector.

Auto and secure connectors layer per-request TLS pieces on top of this base. Tunnel connectors intentionally use only this base plus the proxy-scoped TlsTunnel fields.

pub fn maybe_set_base_config( &mut self, base: Option<TlsClientConfig>, ) -> &mut TlsConnector<S, K>

Set the base TlsClientConfig for this connector.

Auto and secure connectors layer per-request TLS pieces on top of this base. Tunnel connectors intentionally use only this base plus the proxy-scoped TlsTunnel fields.

pub fn with_base_config(self, base: TlsClientConfig) -> TlsConnector<S, K>

Set the base TlsClientConfig for this connector.

Auto and secure connectors layer per-request TLS pieces on top of this base. Tunnel connectors intentionally use only this base plus the proxy-scoped TlsTunnel fields.

pub fn set_base_config( &mut self, base: TlsClientConfig, ) -> &mut TlsConnector<S, K>

Set the base TlsClientConfig for this connector.

Auto and secure connectors layer per-request TLS pieces on top of this base. Tunnel connectors intentionally use only this base plus the proxy-scoped TlsTunnel fields.

pub fn without_base_config(self) -> TlsConnector<S, K>

Set the base TlsClientConfig for this connector.

Auto and secure connectors layer per-request TLS pieces on top of this base. Tunnel connectors intentionally use only this base plus the proxy-scoped TlsTunnel fields.

pub fn unset_base_config(&mut self) -> &mut TlsConnector<S, K>

Set the base TlsClientConfig for this connector.

Auto and secure connectors layer per-request TLS pieces on top of this base. Tunnel connectors intentionally use only this base plus the proxy-scoped TlsTunnel fields.

pub fn maybe_with_session_store( self, store: Option<Arc<dyn TlsClientSessionStore>>, ) -> TlsConnector<S, K>

Resume TLS sessions with servers this connector connected to before, keeping them in store. Off by default.

A session only resumes with the server identity it was established with, under the same security policy and optional emulation profile scope. Compatible drawn extension orders can use sibling native contexts. Separate connectors stay isolated even when they share a store; clones of this connector share its session domain.

pub fn maybe_set_session_store( &mut self, store: Option<Arc<dyn TlsClientSessionStore>>, ) -> &mut TlsConnector<S, K>

Resume TLS sessions with servers this connector connected to before, keeping them in store. Off by default.

A session only resumes with the server identity it was established with, under the same security policy and optional emulation profile scope. Compatible drawn extension orders can use sibling native contexts. Separate connectors stay isolated even when they share a store; clones of this connector share its session domain.

pub fn with_session_store( self, store: Arc<dyn TlsClientSessionStore>, ) -> TlsConnector<S, K>

Resume TLS sessions with servers this connector connected to before, keeping them in store. Off by default.

A session only resumes with the server identity it was established with, under the same security policy and optional emulation profile scope. Compatible drawn extension orders can use sibling native contexts. Separate connectors stay isolated even when they share a store; clones of this connector share its session domain.

pub fn set_session_store( &mut self, store: Arc<dyn TlsClientSessionStore>, ) -> &mut TlsConnector<S, K>

Resume TLS sessions with servers this connector connected to before, keeping them in store. Off by default.

A session only resumes with the server identity it was established with, under the same security policy and optional emulation profile scope. Compatible drawn extension orders can use sibling native contexts. Separate connectors stay isolated even when they share a store; clones of this connector share its session domain.

pub fn without_session_store(self) -> TlsConnector<S, K>

Resume TLS sessions with servers this connector connected to before, keeping them in store. Off by default.

A session only resumes with the server identity it was established with, under the same security policy and optional emulation profile scope. Compatible drawn extension orders can use sibling native contexts. Separate connectors stay isolated even when they share a store; clones of this connector share its session domain.

pub fn unset_session_store(&mut self) -> &mut TlsConnector<S, K>

Resume TLS sessions with servers this connector connected to before, keeping them in store. Off by default.

A session only resumes with the server identity it was established with, under the same security policy and optional emulation profile scope. Compatible drawn extension orders can use sibling native contexts. Separate connectors stay isolated even when they share a store; clones of this connector share its session domain.

impl<S> TlsConnector<S>

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

Creates a new TlsConnector which will establish a secure connection when the input protocol is secure. Otherwise it forwards the inner connection. The logical authority remains the default server identity.

impl<S> TlsConnector<S, ConnectorKindSecure>

pub const 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 const 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 duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

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. Read more

impl<S, Input> Service<Input> for TlsConnector<S>
where S: ConnectorService<Input>, <S as ConnectorService<Input>>::Connection: Io + Unpin, Input: AuthorityInputExt + ProtocolInputExt + Send + ExtensionsRef + 'static,

type Output = EstablishedClientConnection<AutoTlsStream<<S as ConnectorService<Input>>::Connection>, Input>

The type of the output returned by the service.

type Error = ConnectionError

The type of error returned by the service.

async fn serve( &self, input: Input, ) -> Result<<TlsConnector<S> as Service<Input>>::Output, <TlsConnector<S> as Service<Input>>::Error>

Serve an output or an error for the given input

fn boxed(self) -> BoxService<Input, Self::Output, Self::Error>

Box this service to allow for dynamic dispatch.

impl<S, Input> Service<Input> for TlsConnector<S, ConnectorKindSecure>
where S: ConnectorService<Input>, <S as ConnectorService<Input>>::Connection: Io + Unpin, Input: AuthorityInputExt + ProtocolInputExt + Send + ExtensionsRef + 'static,

type Output = EstablishedClientConnection<TlsStream<<S as ConnectorService<Input>>::Connection>, Input>

The type of the output returned by the service.

type Error = ConnectionError

The type of error returned by the service.

async fn serve( &self, input: Input, ) -> Result<<TlsConnector<S, ConnectorKindSecure> as Service<Input>>::Output, <TlsConnector<S, ConnectorKindSecure> as Service<Input>>::Error>

Serve an output or an error for the given input

fn boxed(self) -> BoxService<Input, Self::Output, Self::Error>

Box this service to allow for dynamic dispatch.

impl<S, Input> Service<Input> for TlsConnector<S, ConnectorKindTunnel>
where S: ConnectorService<Input>, <S as ConnectorService<Input>>::Connection: Io + Unpin, Input: Send + ExtensionsRef + 'static,

type Output = EstablishedClientConnection<AutoTlsStream<<S as ConnectorService<Input>>::Connection>, Input>

The type of the output returned by the service.

type Error = ConnectionError

The type of error returned by the service.

async fn serve( &self, input: Input, ) -> Result<<TlsConnector<S, ConnectorKindTunnel> as Service<Input>>::Output, <TlsConnector<S, ConnectorKindTunnel> as Service<Input>>::Error>

Serve an output or an error for the given input

fn boxed(self) -> BoxService<Input, Self::Output, Self::Error>

Box this service to allow for dynamic dispatch.

Auto Trait Implementations§

impl<S, K = ConnectorKindAuto> !RefUnwindSafe for TlsConnector<S, K>

impl<S, K = ConnectorKindAuto> !UnwindSafe for TlsConnector<S, K>

impl<S, K> Freeze for TlsConnector<S, K>
where S: Freeze, K: Freeze,

impl<S, K> Send for TlsConnector<S, K>
where S: Send, K: Send,

impl<S, K> Sync for TlsConnector<S, K>
where S: Sync, K: Sync,

impl<S, K> Unpin for TlsConnector<S, K>
where S: Unpin, K: Unpin,

impl<S, K> UnsafeUnpin for TlsConnector<S, K>
where S: UnsafeUnpin, K: UnsafeUnpin,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<S, Input, Connection> ConnectorService<Input> for S
where S: Service<Input, Output = EstablishedClientConnection<Connection, Input>>, <S as Service<Input>>::Error: Into<ConnectionError>, Connection: Send + ExtensionsRef,

type Connection = Connection

Connection returned by the ConnectorService

fn connect( &self, input: Input, ) -> impl Future<Output = Result<EstablishedClientConnection<<S as ConnectorService<Input>>::Connection, Input>, ConnectionError>> + Send

Establish a connection, which often involves some kind of handshake, or connection revival. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromRef<T> for T
where T: Clone,

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more

impl<T, ReqBody, ResBody> GrpcService<ReqBody> for T
where T: Service<Request<ReqBody>, Output = Response<ResBody>>, <T as Service<Request<ReqBody>>>::Error: Into<Box<dyn Error + Sync + Send>>, ResBody: Body, <ResBody as Body>::Error: Into<Box<dyn Error + Sync + Send>>,

type ResponseBody = ResBody

Responses body given by the service.

type Error = <T as Service<Request<ReqBody>>>::Error

Errors produced by the service.

fn serve( &self, request: Request<ReqBody>, ) -> impl Future<Output = Result<Response<<T as GrpcService<ReqBody>>::ResponseBody>, <T as GrpcService<ReqBody>>::Error>> + Send

Process the request and return the response asynchronously. Read more

impl<S, Body> HttpClientExt for S
where S: Service<Request, Output = Response<Body>>, <S as Service<Request>>::Error: Into<Box<dyn Error + Sync + Send>>,

type ExecuteResponse = Response<Body>

The response type returned by the execute method.

type ExecuteError = <S as Service<Request>>::Error

The error type returned by the execute method.

fn get( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Convenience method to make a GET request to a URL. Read more

fn post( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Convenience method to make a POST request to a URL. Read more

fn put( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Convenience method to make a PUT request to a URL. Read more

fn patch( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Convenience method to make a PATCH request to a URL. Read more

fn delete( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Convenience method to make a DELETE request to a URL. Read more

fn head( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Convenience method to make a HEAD request to a URL. Read more

fn connect( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Convenience method to make a CONNECT request to a URL. Read more

fn query( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Convenience method to make a QUERY request to a URL. Read more

fn request( &self, method: Method, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Start building a Request with the Method and Url. Read more

fn build_from_request<RequestBody>( &self, request: Request<RequestBody>, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>
where RequestBody: Into<Body>,

Start building a Request, using the given Request. Read more

fn execute( &self, request: Request, ) -> impl Future<Output = Result<<S as HttpClientExt>::ExecuteResponse, <S as HttpClientExt>::ExecuteError>>

Executes a Request. Read more

impl<S, Body> HttpClientWebSocketExt<Body> for S
where S: Service<Request, Output = Response<Body>>, <S as Service<Request>>::Error: Into<Box<dyn Error + Sync + Send>>,

fn websocket( &self, url: impl IntoUrl, ) -> WebSocketRequestBuilder<WithService<'_, S, Body>>

Create a new WebSocketRequestBuilder] to be used to establish a WebSocket connection over http/1.1.

fn websocket_h2( &self, url: impl IntoUrl, ) -> WebSocketRequestBuilder<WithService<'_, S, Body>>

Create a new WebSocketRequestBuilder to be used to establish a WebSocket connection over h2.

fn websocket_h3( &self, url: impl IntoUrl, ) -> WebSocketRequestBuilder<WithService<'_, S, Body>>

Create a new WebSocketRequestBuilder to be used to establish a WebSocket connection over h3.

fn websocket_with_request<RequestBody>( &self, req: Request<RequestBody>, ) -> WebSocketRequestBuilder<WithService<'_, S, Body>>
where RequestBody: Into<Body>,

Create a new WebSocketRequestBuilder starting from the given request. Read more

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<S> IntoEndpointService<(S,)> for S
where S: Service<Request>,

type Service = S

fn into_endpoint_service(self) -> <S as IntoEndpointService<(S,)>>::Service

convert the type into a rama_core::Service.

impl<S, State> IntoEndpointServiceWithState<(S,), State> for S
where S: Service<Request>,

type Service = S

fn into_endpoint_service_with_state( self, _state: State, ) -> <S as IntoEndpointServiceWithState<(S,), State>>::Service

convert the type into a rama_core::Service with state.

impl<T> IntoRequest<T> for T

fn into_request(self) -> Request<T>

Wrap the input message T in a rama_grpc::Request

impl<L> LayerExt<L> for L

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T, U> RamaFrom<T> for U
where U: From<T>,

fn rama_from(value: T) -> U

impl<T, U, CrateMarker> RamaInto<U, CrateMarker> for T
where U: RamaFrom<T, CrateMarker>,

fn rama_into(self) -> U

impl<T, U> RamaTryFrom<T> for U
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn rama_try_from(value: T) -> Result<U, <U as RamaTryFrom<T>>::Error>

impl<T, U, CrateMarker> RamaTryInto<U, CrateMarker> for T
where U: RamaTryFrom<T, CrateMarker>,

type Error = <U as RamaTryFrom<T, CrateMarker>>::Error

fn rama_try_into(self) -> Result<U, <U as RamaTryFrom<T, CrateMarker>>::Error>

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<V, F> ValueFormatter<&V> for F
where F: ValueFormatter<V> + ?Sized, V: ?Sized,

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.

The shape of values produced by this formatter. Read more

fn format_value(writer: impl ValueWriter, value: &&V)

Write value to writer

impl<V, F> ValueFormatter<Arc<V>> for F
where F: ValueFormatter<V> + ?Sized, V: ?Sized,

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.

The shape of values produced by this formatter. Read more

fn format_value(writer: impl ValueWriter, value: &Arc<V>)

Write value to writer

impl<V, F> ValueFormatter<Box<V>> for F
where F: ValueFormatter<V> + ?Sized, V: ?Sized,

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.

The shape of values produced by this formatter. Read more

fn format_value(writer: impl ValueWriter, value: &Box<V>)

Write value to writer

impl<V, F> ValueFormatter<Cow<'_, V>> for F
where V: ToOwned + ?Sized, F: ValueFormatter<V> + ?Sized,

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.

The shape of values produced by this formatter. Read more

fn format_value(writer: impl ValueWriter, value: &Cow<'_, V>)

Write value to writer

impl<V, F> ValueFormatter<Option<V>> for F
where F: ValueFormatter<V> + ?Sized,

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.

The shape of values produced by this formatter. Read more

fn format_value(writer: impl ValueWriter, value: &Option<V>)

Write value to writer

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more