Struct ErrorResult 

pub struct ErrorResult {
    pub message: String,
    pub data: Option<Value>,
    pub code: u16,
}

Handler failure value: message, optional JSON payload, and HTTP status code. Returned as Err from handlers and rendered as an {"status":"error",...} envelope.

Fields

message: String

Human-readable error message.

data: Option<Value>

Optional extra error payload.

code: u16

HTTP status code for the response.

Implementations

impl ErrorResult

pub fn new(message: impl Into<String>, data: Option<Value>, code: u16) -> Self

Creates an error with an explicit message, optional data, and HTTP status code.

pub fn forbidden(msg: impl Into<String>) -> Self

Creates a 403 error with the given message.

pub fn service_unavailable(msg: impl Into<String>) -> Self

Creates a 503 error with the given message.

pub fn bad_request(msg: impl Into<String>) -> Self

Creates a 400 error with the given message.

pub fn not_found(msg: impl Into<String>) -> Self

Creates a 404 error with the given message.

pub fn internal(msg: impl Into<String>) -> Self

Creates a 500 error with the given message.

pub fn from_error<E: Display + ?Sized>(err: &E, code: u16) -> Self

Creates an error from a displayable value with an explicit HTTP status code.

pub fn of(err: &Error) -> Self

Maps an anyhow error to a 400 when its message suggests bad input or a missing resource (validation/invalid/not found), otherwise to a 500.

pub fn to_service_result(&self) -> ServiceResult<Value>

Converts this error into an "error"-status ServiceResult for rendering.

pub fn code(&self) -> u16

Returns the HTTP status code for this error.

Trait Implementations

impl Clone for ErrorResult

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorResult

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

Formats the value using the given formatter.

impl Display for ErrorResult

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

Formats the value using the given formatter.

impl Error for ErrorResult

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<DbErr> for ErrorResult

fn from(err: DbErr) -> Self

Converts to this type from the input type.

impl Serialize for ErrorResult

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TypedServiceResult for ErrorResult

fn message(&self) -> &str

Human-readable message carried by the result.

fn code(&self) -> u16

HTTP status code used for the response.

fn response_type(&self) -> ResponseType

Content type used for the Content-Type header.

fn serialize(&self) -> Result<String, Error>

Renders the response body; I/O or shape errors surface as serde_json::Error.

fn data_json(&self) -> Option<Value>

Returns the payload as JSON when representable; defaults to None.