pub struct GrpcErrorsAsFailures { /* private fields */ }
Expand description

Response classifier for gRPC responses.

gRPC doesn’t use normal HTTP statuses for indicating success or failure but instead a special header that might appear in a trailer.

Responses are considered successful if

  • grpc-status header value matches GrpcErrorsAsFailures (only Ok by default).
  • grpc-status header is missing.
  • grpc-status header value isn’t a valid String.
  • grpc-status header value can’t parsed into an i32.

All others are considered failures.

Implementations§

source§

impl GrpcErrorsAsFailures

source

pub fn new() -> Self

Create a new GrpcErrorsAsFailures.

source

pub fn with_success(self, code: GrpcCode) -> Self

Change which gRPC codes are considered success.

Defaults to only considering Ok as success.

Ok will always be considered a success.

Example

Servers might not want to consider Invalid Argument or Not Found as failures since thats likely the clients fault:

use tower_http::classify::{GrpcErrorsAsFailures, GrpcCode};

let classifier = GrpcErrorsAsFailures::new()
    .with_success(GrpcCode::InvalidArgument)
    .with_success(GrpcCode::NotFound);
source

pub fn make_classifier() -> SharedClassifier<Self>

Returns a MakeClassifier that produces GrpcErrorsAsFailures.

This is a convenience function that simply calls SharedClassifier::new.

Trait Implementations§

source§

impl ClassifyResponse for GrpcErrorsAsFailures

§

type FailureClass = GrpcFailureClass

The type returned when a response is classified as a failure. Read more
§

type ClassifyEos = GrpcEosErrorsAsFailures

The type used to classify the response end of stream (EOS).
source§

fn classify_response<B>( self, res: &Response<B> ) -> ClassifiedResponse<Self::FailureClass, Self::ClassifyEos>

Attempt to classify the beginning of a response. Read more
source§

fn classify_error<E>(self, error: &E) -> Self::FailureClasswhere E: Display + 'static,

Classify an error. Read more
source§

fn map_failure_class<F, NewClass>(self, f: F) -> MapFailureClass<Self, F>where Self: Sized, F: FnOnce(Self::FailureClass) -> NewClass,

Transform the failure classification using a function. Read more
source§

impl Clone for GrpcErrorsAsFailures

source§

fn clone(&self) -> GrpcErrorsAsFailures

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for GrpcErrorsAsFailures

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for GrpcErrorsAsFailures

source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

source§

fn into(self) -> U

Calls U::from(self).

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

source§

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

source§

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

Available on crate feature follow-redirect only.
Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
source§

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

Available on crate feature follow-redirect only.
Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

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

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

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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