Struct HttpWebSocketRelayServiceRequestMatcher 

pub struct HttpWebSocketRelayServiceRequestMatcher<S = IoForwardService> { /* private fields */ }

Default matcher that can be used for Http websocket relays.

Request matches for an http websocket request return a HttpWebSocketRelayServiceResponseMatcher instance which will match on 101 status code responses…

Note

This matcher does NOT validate if client <-> server handshake flow is compatible with one another. This in contrast to Rama’s pure client / server implementations, the MITM flow typically should not botter with that, given there are always those odd balls out there which have RFC incompatible definitions of reality. Fork this file if you have more advanced needs… or feel free to make a proposal on improvements to this file while still respecting its spirit.

Implementations

impl HttpWebSocketRelayServiceRequestMatcher

pub fn default_with_exec(exec: Executor) -> Self

Create a HttpWebSocketRelayServiceRequestMatcher whose default fallback relay observes graceful shutdown via the given Executor.

Prefer this over Self::default when you have an executor available — it lets the relay bridge unwind cleanly on shutdown.

impl<S> HttpWebSocketRelayServiceRequestMatcher<S>

pub fn new(relay_svc: S) -> Self

Create a new HttpWebSocketRelayServiceRequestMatcher.

pub fn maybe_with_websocket_config(self, cfg: Option<WebSocketConfig>) -> Self

Set the base WebSocketConfig, used for both sides, overwriting the previous config if already set.

pub fn maybe_set_websocket_config( &mut self, cfg: Option<WebSocketConfig>, ) -> &mut Self

Set the base WebSocketConfig, used for both sides, overwriting the previous config if already set.

pub fn with_websocket_config(self, cfg: WebSocketConfig) -> Self

Set the base WebSocketConfig, used for both sides, overwriting the previous config if already set.

pub fn set_websocket_config(&mut self, cfg: WebSocketConfig) -> &mut Self

Set the base WebSocketConfig, used for both sides, overwriting the previous config if already set.

pub fn without_websocket_config(self) -> Self

Set the base WebSocketConfig, used for both sides, overwriting the previous config if already set.

pub fn unset_websocket_config(&mut self) -> &mut Self

Set the base WebSocketConfig, used for both sides, overwriting the previous config if already set.

pub fn with_store_handshake_request_header(self, store: bool) -> Self

Define if the handshake (http) request headers needs to be stored in the Ingress Io extensions.

By default it is not stored.

Note

It is only stored if requested AND the request is matched.

pub fn set_store_handshake_request_header(&mut self, store: bool) -> &mut Self

Define if the handshake (http) request headers needs to be stored in the Ingress Io extensions.

By default it is not stored.

Note

It is only stored if requested AND the request is matched.

pub fn with_store_handshake_response_header(self, store: bool) -> Self

Define if the handshake (http) response headers needs to be stored in the Ingress Io extensions.

By default it is not stored.

Note

It is only stored if requested AND the response is matched.

pub fn set_store_handshake_response_header(&mut self, store: bool) -> &mut Self

Define if the handshake (http) response headers needs to be stored in the Ingress Io extensions.

By default it is not stored.

Note

It is only stored if requested AND the response is matched.

Trait Implementations

impl<S: Clone> Clone for HttpWebSocketRelayServiceRequestMatcher<S>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for HttpWebSocketRelayServiceRequestMatcher<S>

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

Formats the value using the given formatter.

impl Default for HttpWebSocketRelayServiceRequestMatcher

fn default() -> Self

Returns the “default value” for a type.

impl<S, Body> ServiceMatcher<Request<Body>> for HttpWebSocketRelayServiceRequestMatcher<S>

where S: Clone + Send + Sync + 'static, Body: Send + 'static,

type Service = HttpWebSocketRelayServiceResponseMatcher<S>

The value returned when a match succeeds.

type Error = !

The error that can happen while evaluating the matcher.

type ModifiedInput = Request<Body>

Input returned by matching functions, it might be same as the original input but it can also be modified.

async fn match_service( &self, req: Request<Body>, ) -> Result<ServiceMatch<Self::ModifiedInput, Self::Service>, Self::Error>

Attempt to select a service for input.

async fn into_match_service( self, req: Request<Body>, ) -> Result<ServiceMatch<Self::ModifiedInput, Self::Service>, Self::Error>

Attempt to select a service for input, consuming the matcher.

fn boxed( self, ) -> BoxServiceMatcher<Input, Self::Service, Self::Error, Self::ModifiedInput>

where Self: Sized,

Box this matcher for dynamic dispatch.