Struct RestError 

pub struct RestError(/* private fields */);

REST error wrapper — converts tonic::Status to an HTTP error response.

Maps gRPC status codes to HTTP status codes and returns a JSON error body following the Google API error model:

{
  "error": { "code": 400, "message": "...", "status": "INVALID_ARGUMENT" }
}

Response Format

The JSON shape is intentionally fixed to the Google API error convention. This provides a consistent, well-documented error format across all generated REST endpoints. The body wraps the error in an "error" object:

{ "error": { "code": 404, "message": "...", "status": "NOT_FOUND" } }

Note: SSE error events (via sse_error_event) use the same {"error": {...}} format, ensuring a consistent error shape across both HTTP JSON and SSE transports.

If you need a custom error shape, implement axum::response::IntoResponse on your own error type and set the runtime_crate config in tonic-rest-build to point to the module containing your custom types.

Constructing

Use From<tonic::Status> or RestError::new:

let err = RestError::new(tonic::Status::not_found("gone"));
let err: RestError = tonic::Status::not_found("gone").into();

Examples

Convert a tonic status to an Axum-compatible HTTP response:

use tonic_rest::RestError;
use axum::response::IntoResponse;

let err = RestError::new(tonic::Status::not_found("user not found"));
let response = err.into_response();
assert_eq!(response.status(), axum::http::StatusCode::NOT_FOUND);

Implementations

impl RestError

pub const fn new(status: Status) -> Self

Create a new RestError from a tonic::Status.

pub const fn status(&self) -> &Status

Returns a reference to the underlying tonic::Status.

pub fn into_status(self) -> Status

Consumes the RestError and returns the underlying tonic::Status.

Trait Implementations

impl Clone for RestError

fn clone(&self) -> RestError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RestError

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

Formats the value using the given formatter.

impl Display for RestError

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

Formats the value using the given formatter.

impl Error for RestError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Status> for RestError

fn from(status: Status) -> Self

Converts to this type from the input type.

impl IntoResponse for RestError

fn into_response(self) -> Response

Create a response.