Struct rustyms::error::CustomError

pub struct CustomError { /* private fields */ }

An error

Implementations

impl CustomError

pub fn error( short_desc: impl ToString, long_desc: impl ToString, context: Context ) -> Self

Create a new CustomError

Arguments

• short_desc - A short description of the error, generally used as title line
• long_desc - A longer description of the error, presented below the context to give more information and helpful feedback
• context - The context, in the most general sense this produces output which leads the user to the right place in the code or file

pub fn warning( short_desc: impl ToString, long_desc: impl ToString, context: Context ) -> Self

Create a new CustomError

Arguments

• short_desc - A short description of the error, generally used as title line
• long_desc - A longer description of the error, presented below the context to give more information and helpful feedback
• context - The context, in the most general sense this produces output which leads the user to the right place in the code or file

pub const fn level(&self) -> &str

The level of the error

pub const fn is_warning(&self) -> bool

Tests if this errors is a warning

pub fn short_description(&self) -> &str

Gives the short description or title for this error

pub fn long_description(&self) -> &str

Gives the long description for this error

pub fn with_long_description(&self, long_desc: impl ToString) -> Self

Create a copy of the error with a new long description

pub fn with_context(&self, context: Context) -> Self

Create a copy of the error with a new context

pub fn overwrite_line_number(&self, line_number: usize) -> Self

Overwrite the line number with the given number, if applicable

pub const fn context(&self) -> &Context

Gives the context for this error

Trait Implementations

impl Clone for CustomError

fn clone(&self) -> CustomError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CustomError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CustomError

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CustomError

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

Formats the value using the given formatter.

impl Error for CustomError

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

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 PartialEq for CustomError

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CustomError

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CustomError

impl StructuralEq for CustomError

impl StructuralPartialEq for CustomError