Struct UpgradeLayer 

pub struct UpgradeLayer<O> { /* private fields */ }

UpgradeLayer is a middleware that can be used to upgrade a request.

See UpgradeService for more details.

Implementations

impl<O> UpgradeLayer<O>

pub fn new<M, R, H>( exec: Executor, matcher: M, responder: R, handler: H, ) -> Self

where M: Matcher<Request>, R: Service<Request, Output = UpgradeResponse<Request, O>, Error = O> + Clone, H: Service<Upgraded, Output = (), Error: Into<BoxError>> + Clone,

Create a new upgrade layer whose handler’s errors are routed to the default ErrorSink (TracingErrorSink::default, DEBUG level).

Use UpgradeLayer::new_with_error_sink to give the handler a custom sink (which also lifts the Error: Into<BoxError> requirement, allowing any handler error type).

pub fn new_with_error_sink<M, R, H, Sink>( exec: Executor, matcher: M, responder: R, handler: H, sink: Sink, ) -> Self

where M: Matcher<Request>, R: Service<Request, Output = UpgradeResponse<Request, O>, Error = O> + Clone, H: Service<Upgraded, Output = ()> + Clone, Sink: ErrorSink<H::Error>,

Create a new upgrade layer, routing the handler’s errors (of any type) to the given ErrorSink.

pub fn new_dropping_errors<M, R, H>( exec: Executor, matcher: M, responder: R, handler: H, ) -> Self

where M: Matcher<Request>, R: Service<Request, Output = UpgradeResponse<Request, O>, Error = O> + Clone, H: Service<Upgraded, Output = ()> + Clone,

Create a new upgrade layer whose handler’s errors (of any type) are silently dropped (DropErrorSink). Use this for handlers whose errors are neither actionable nor traceable.

pub fn on<M, R, H>(self, matcher: M, responder: R, handler: H) -> Self

where M: Matcher<Request>, R: Service<Request, Output = UpgradeResponse<Request, O>, Error = O> + Clone, H: Service<Upgraded, Output = (), Error: Into<BoxError>> + Clone,

Add an extra upgrade handler, routing its errors to the default ErrorSink (TracingErrorSink::default, DEBUG level).

pub fn on_dropping_errors<M, R, H>( self, matcher: M, responder: R, handler: H, ) -> Self

where M: Matcher<Request>, R: Service<Request, Output = UpgradeResponse<Request, O>, Error = O> + Clone, H: Service<Upgraded, Output = ()> + Clone,

Add an extra upgrade handler whose errors (of any type) are silently dropped (DropErrorSink).

pub fn on_with_error_sink<M, R, H, Sink>( self, matcher: M, responder: R, handler: H, sink: Sink, ) -> Self

where M: Matcher<Request>, R: Service<Request, Output = UpgradeResponse<Request, O>, Error = O> + Clone, H: Service<Upgraded, Output = ()> + Clone, Sink: ErrorSink<H::Error>,

Add an extra upgrade handler, routing its errors (of any type) to the given ErrorSink.

pub fn with_upgrade_error_sink(self, sink: impl ErrorSink) -> Self

Set the ErrorSink used for errors that occur while establishing the upgraded connection (i.e. the HTTP upgrade itself fails, before any handler runs). Per-handler errors are routed to their own sink instead; see UpgradeLayer::on_with_error_sink.

Defaults to TracingErrorSink::default (traces at DEBUG level).

Trait Implementations

impl<O> Clone for UpgradeLayer<O>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<O> Debug for UpgradeLayer<O>

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

Formats the value using the given formatter.

impl<S, O> Layer<S> for UpgradeLayer<O>

type Service = UpgradeService<S, O>

The service produced by the layer.

fn layer(&self, inner: S) -> Self::Service

Wrap the given service with the middleware, returning a new service.

fn into_layer(self, inner: S) -> Self::Service

Same as layer but consuming self after the service was created.