rama::tls::boring::client

Struct TlsConnector

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

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

Implementations§

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

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

Set base TlsConnectorDataBuilder that will be used for this connector

This builder will be chained with the TlsConnectorDataBuilder found in the context in this order: BaseBuilder -> CtxBuilder

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_set_connector_data( &mut self, connector_data: Option<Arc<TlsConnectorDataBuilder>>, ) -> &mut TlsConnector<S, K>

Set base TlsConnectorDataBuilder that will be used for this connector

This builder will be chained with the TlsConnectorDataBuilder found in the context in this order: BaseBuilder -> CtxBuilder

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 with_connector_data( self, connector_data: Arc<TlsConnectorDataBuilder>, ) -> TlsConnector<S, K>

Set base TlsConnectorDataBuilder that will be used for this connector

This builder will be chained with the TlsConnectorDataBuilder found in the context in this order: BaseBuilder -> CtxBuilder

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 set_connector_data( &mut self, connector_data: Arc<TlsConnectorDataBuilder>, ) -> &mut TlsConnector<S, K>

Set base TlsConnectorDataBuilder that will be used for this connector

This builder will be chained with the TlsConnectorDataBuilder found in the context in this order: BaseBuilder -> CtxBuilder

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 without_connector_data(self) -> TlsConnector<S, K>

Set base TlsConnectorDataBuilder that will be used for this connector

This builder will be chained with the TlsConnectorDataBuilder found in the context in this order: BaseBuilder -> CtxBuilder

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 unset_connector_data(&mut self) -> &mut TlsConnector<S, K>

Set base TlsConnectorDataBuilder that will be used for this connector

This builder will be chained with the TlsConnectorDataBuilder found in the context in this order: BaseBuilder -> CtxBuilder

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.

impl<S> TlsConnector<S>

pub const 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 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 · 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, Request> Service<Request> for TlsConnector<S>
where S: ConnectorService<Request>, <S as ConnectorService<Request>>::Connection: Stream + Unpin, <S as ConnectorService<Request>>::Error: Into<Box<dyn Error + Sync + Send>>, Request: TryRefIntoTransportContext + Send + 'static, <Request as TryRefIntoTransportContext>::Error: Into<Box<dyn Error + Sync + Send>> + Send + 'static,

type Response = EstablishedClientConnection<AutoTlsStream<<S as ConnectorService<Request>>::Connection>, 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, req: Request, ) -> Result<<TlsConnector<S> as Service<Request>>::Response, <TlsConnector<S> as Service<Request>>::Error>

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

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

Box this service to allow for dynamic dispatch.

impl<S, Request> Service<Request> for TlsConnector<S, ConnectorKindSecure>
where S: ConnectorService<Request>, <S as ConnectorService<Request>>::Connection: Stream + Unpin, <S as ConnectorService<Request>>::Error: Into<Box<dyn Error + Sync + Send>>, Request: TryRefIntoTransportContext + Send + 'static, <Request as TryRefIntoTransportContext>::Error: Into<Box<dyn Error + Sync + Send>> + Send + 'static,

type Response = EstablishedClientConnection<TlsStream<<S as ConnectorService<Request>>::Connection>, 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, req: Request, ) -> Result<<TlsConnector<S, ConnectorKindSecure> as Service<Request>>::Response, <TlsConnector<S, ConnectorKindSecure> as Service<Request>>::Error>

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

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

Box this service to allow for dynamic dispatch.

impl<S, Request> Service<Request> for TlsConnector<S, ConnectorKindTunnel>
where S: ConnectorService<Request>, <S as ConnectorService<Request>>::Connection: Stream + Unpin, <S as ConnectorService<Request>>::Error: Into<Box<dyn Error + Sync + Send>>, Request: Send + 'static,

type Response = EstablishedClientConnection<AutoTlsStream<<S as ConnectorService<Request>>::Connection>, 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, req: Request, ) -> Result<<TlsConnector<S, ConnectorKindTunnel> as Service<Request>>::Response, <TlsConnector<S, ConnectorKindTunnel> as Service<Request>>::Error>

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

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

Box this service to allow for dynamic dispatch.

Auto Trait Implementations§

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

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

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> UnwindSafe for TlsConnector<S, K>
where S: UnwindSafe, K: UnwindSafe,

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<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, Request, Connection> ConnectorService<Request> for S
where S: Service<Request, Response = EstablishedClientConnection<Connection, Request>>, <S as Service<Request>>::Error: Into<Box<dyn Error + Sync + Send>>,

type Connection = Connection

Connection returned by the ConnectorService

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

Error returned in case of connection / setup failure

fn connect( &self, ctx: Context, req: Request, ) -> impl Future<Output = Result<EstablishedClientConnection<<S as ConnectorService<Request>>::Connection, Request>, <S as ConnectorService<Request>>::Error>> + Send

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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<S, Body> HttpClientExt for S
where S: Service<Request, Response = 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 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, ctx: Context, 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, Response = 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_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, R> IntoEndpointService<(R,)> for S
where S: Service<Request, Response = R, Error = Infallible>, R: IntoResponse + Send + Sync + 'static,

fn into_endpoint_service( self, ) -> impl Service<Request, Response = Response, Error = Infallible>

convert the type into a rama_core::Service.

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: 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: 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<S, RequestIn, RequestOut> RequestInspector<RequestIn> for S
where S: Service<RequestIn, Response = (Context, RequestOut)>, RequestIn: Send + 'static, RequestOut: Send + 'static,

type Error = <S as Service<RequestIn>>::Error

The type of error returned by the service.

type RequestOut = RequestOut

fn inspect_request( &self, ctx: Context, req: RequestIn, ) -> impl Future<Output = Result<(Context, <S as RequestInspector<RequestIn>>::RequestOut), <S as RequestInspector<RequestIn>>::Error>> + Send

Inspect the request, modify it if needed or desired, and return it.

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 = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

impl<T> ErasedDestructor for T
where T: 'static,