Struct axum_tonic::GrpcStatus

pub struct GrpcStatus(pub Status);

A simple wrapper around a tonic::Status usable in axum middleware.

Example

use axum::{middleware::{Next, from_fn}, response::Response, Router};
use axum_tonic::GrpcStatus;
use hyper::Request;

async fn tonic_middleware<B>(
    req: Request<B>,
    next: Next<B>
) -> Result<Response, GrpcStatus> {
    if is_auth(&req) {
        Ok(next.run(req).await)
    } else {
        Err(
            tonic::Status::permission_denied("Not authenticated").into()
        )
    }
}

fn is_auth<B>(req: &Request<B>) -> bool {
    true // or other logic
}

let router: Router<()> = Router::new()
    .layer(from_fn(tonic_middleware));

Tuple Fields

0: Status

Methods from Deref<Target = Status>

pub fn code(&self) -> Code

Get the gRPC Code of this Status.

pub fn message(&self) -> &str

Get the text error message of this Status.

pub fn details(&self) -> &[u8]

Get the opaque error details of this Status.

pub fn metadata(&self) -> &MetadataMap

Get a reference to the custom metadata.

pub fn metadata_mut(&mut self) -> &mut MetadataMap

Get a mutable reference to the custom metadata.

pub fn add_header(&self, header_map: &mut HeaderMap) -> Result<(), Status>

Add headers from this Status into header_map.

pub fn set_source( &mut self, source: Arc<dyn Error + Send + Sync> ) -> &mut Status

Add a source error to this status.

Trait Implementations

impl Debug for GrpcStatus

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

Formats the value using the given formatter.

impl Deref for GrpcStatus

type Target = Status

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for GrpcStatus

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl From<Status> for GrpcStatus

fn from(s: Status) -> Self

Converts to this type from the input type.

impl IntoResponse for GrpcStatus

fn into_response(self) -> Response

Create a response.