Struct GrpcErrorsAsFailures

pub struct GrpcErrorsAsFailures { /* private fields */ }

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 contains a success value. 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

impl GrpcErrorsAsFailures

pub fn new() -> Self

Create a new GrpcErrorsAsFailures.

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

pub fn make_classifier() -> SharedClassifier<Self>

Returns a MakeClassifier that produces GrpcErrorsAsFailures.

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

Trait Implementations

impl ClassifyResponse for GrpcErrorsAsFailures

type FailureClass = GrpcFailureClass

The type returned when a response is classified as a failure.

type ClassifyEos = GrpcEosErrorsAsFailures

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

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

Attempt to classify the beginning of a response.

fn classify_error<E>(self, error: &E) -> Self::FailureClass

where E: Display + 'static,

Classify an error.

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.

impl Clone for GrpcErrorsAsFailures

fn clone(&self) -> GrpcErrorsAsFailures

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GrpcErrorsAsFailures

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

Formats the value using the given formatter.

impl Default for GrpcErrorsAsFailures

fn default() -> Self

Returns the “default value” for a type.