Struct seamless::api::ApiError

pub struct ApiError {
    pub code: u16,
    pub internal_message: String,
    pub external_message: String,
    pub value: Option<Value>,
}

This represents an API error that is returned from the API.

Fields

code: u16

What the HTTP status code should be for this error response.

internal_message: String

A message that can be logged internally but should not be shown to API consumers.

external_message: String

A message that can be shown to API consumers.

value: Option<Value>

Some optional context which could contain arbitrary information. It's expected that this could be handed back to API consumers and so shouldn't contain anything sensitive.

Implementations

impl ApiError

pub fn server_error<S: Into<String>>(msg: S) -> ApiError

A helper to instantiate a server error.

pub fn path_not_found() -> ApiError

A helper to instantiate a 404 not found error.

pub fn not_authorized(reason: &str) -> ApiError

A helper to instantiate a not authorized error.

Trait Implementations

impl Clone for ApiError

fn clone(&self) -> ApiError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ApiError

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

Formats the value using the given formatter.

impl From<Infallible> for ApiError

fn from(_: Infallible) -> ApiError

Performs the conversion.

impl PartialEq<ApiError> for ApiError

fn eq(&self, other: &ApiError) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ApiError) -> bool

This method tests for !=.

impl StructuralPartialEq for ApiError