Skip to main content

DogError

Struct DogError 

Source
pub struct DogError {
    pub kind: ErrorKind,
    pub message: String,
    pub data: Option<ErrorValue>,
    pub errors: Option<ErrorValue>,
    pub source: Option<Error>,
}
Expand description

A structured DogRS error that can live inside anyhow::Error.

Mirrors Feathers-style fields:

  • name
  • message
  • code (HTTP status)
  • class_name
  • data (optional)
  • errors (optional)

Fields§

§kind: ErrorKind§message: String§data: Option<ErrorValue>§errors: Option<ErrorValue>§source: Option<Error>

Implementations§

Source§

impl DogError

Source

pub fn new(kind: ErrorKind, message: impl Into<String>) -> Self

Source

pub fn with_data(self, data: ErrorValue) -> Self

Source

pub fn with_errors(self, errors: ErrorValue) -> Self

Source

pub fn with_source(self, source: AnyError) -> Self

Source

pub fn code(&self) -> u16

Source

pub fn name(&self) -> &'static str

Source

pub fn class_name(&self) -> &'static str

Source

pub fn into_anyhow(self) -> AnyError

Convert into anyhow::Error so it flows through your hook pipeline.

Source

pub fn from_anyhow(err: &AnyError) -> Option<&DogError>

Downcast an anyhow::Error to a DogError if possible.

Source

pub fn normalize(err: AnyError) -> DogError

Turn any error into a DogError:

  • if it’s already a DogError, keep it (lossless)
  • otherwise wrap as GeneralError
Source

pub fn sanitize_for_client(&self) -> DogError

A “safe” version suitable for returning to clients:

  • keep kind/message/code/class_name/data/errors
  • drop the inner source (stack/secret details)
Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Trait Implementations§

Source§

impl Debug for DogError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for DogError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Error for DogError

Source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
1.0.0 · Source§

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

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

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. Read more
Source§

impl IntoAnyhowDogError for DogError

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.