Struct ApiError

pub struct ApiError { /* private fields */ }

Very simple error type - just holds a description of the error. This is useful for human diagnosis and troubleshooting, but not for applications to parse. The justification for this is to deny applications visibility into the communication layer, forcing the application code to act solely on the logical responses that the API provides, promoting abstraction in the application code.

Implementations

impl ApiError

pub fn message(&self) -> &str

pub fn error_type(&self) -> SimpleErrorType

impl ApiError

pub fn new(message: String, error_type: SimpleErrorType) -> ApiError

Trait Implementations

impl Debug for ApiError

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

Formats the value using the given formatter.

impl Display for ApiError

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

Formats the value using the given formatter.

impl Error for ApiError

fn description(&self) -> &str

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

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

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

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<'a> From<&'a str> for ApiError

fn from(e: &str) -> Self

Converts to this type from the input type.

impl From<Error> for ApiError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<String> for ApiError

fn from(e: String) -> Self

Converts to this type from the input type.