Skip to main content

CommonError

Enum CommonError 

Source
pub enum CommonError {
    InvalidInput(String),
    Config(String),
    Io(Error),
    Parse(String),
    NotFound(String),
    PermissionDenied(String),
    Timeout(String),
    External(String),
    Custom(String),
}
Available on crate feature error only.
Expand description

Common error type for ecosystem projects.

This enum covers the most common error cases encountered across projects. For project-specific errors, consider wrapping this or creating derived types.

Variants§

§

InvalidInput(String)

Invalid input provided to a function.

§

Config(String)

Configuration error.

§

Io(Error)

IO operation failed.

§

Parse(String)

Parse error for various formats.

§

NotFound(String)

Resource not found.

§

PermissionDenied(String)

Operation not permitted.

§

Timeout(String)

Operation timed out.

§

External(String)

External service error.

§

Custom(String)

Generic error with custom message.

Implementations§

Source§

impl CommonError

Source

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

Create a new invalid input error.

Source

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

Create a new configuration error.

Source

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

Create a new parse error.

Source

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

Create a new not found error.

Source

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

Create a new custom error.

Source

pub const fn is_input_error(&self) -> bool

Check if this is an input validation error.

Source

pub const fn is_recoverable(&self) -> bool

Check if this is a recoverable error.

Trait Implementations§

Source§

impl Debug for CommonError

Source§

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

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

impl Display for CommonError

Source§

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

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

impl Error for CommonError

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 From<Error> for CommonError

Source§

fn from(source: Error) -> Self

Converts to this type from the input type.

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.