Struct UtilError 

pub struct UtilError {
    error_type: <UtilError as BackendError>::ErrorType,
    message: String,
    source: Option<Error>,
    span_trace: Box<SpanTrace>,
    backtrace: Box<Backtrace>,
    location: Option<&'static Location<'static>>,
}

Error type used by all models. Used as the error type in UtilError, which is used by all the controllers in the application.

All the information in the error is meant to be seen by the user. The type of error is determined by the UtilErrorType enum, which is stored inside this struct.

Examples

Usage without source error

if erroneous_condition {
    return Err(UtilError::new(
        UtilErrorType::Other,
        "File not found".to_string(),
        None,
    ));
}

Usage with a source error

Used when calling a function that returns an error that cannot be automatically converted to an UtilError. (See impl From<X> implementations on this struct.)

some_function_returning_an_error().map_err(|original_error| {
    UtilError::new(
        UtilErrorType::Other,
        "Library x failed to do y".to_string(),
        Some(original_error.into()),
    )
})?;

Fields

error_type: <UtilError as BackendError>::ErrorType

message: String

source: Option<Error>

Original error that caused this error.

span_trace: Box<SpanTrace>

A trace of tokio tracing spans, generated automatically when the error is generated.

backtrace: Box<Backtrace>

Stack trace, generated automatically when the error is created.

location: Option<&'static Location<'static>>

Source location where the error was raised.

Implementations

impl UtilError

fn render_clean_error(&self, out: &mut dyn Write, color: ColorChoice) -> Result

pub fn clean_string(&self, color: ColorChoice) -> String

Render this error in the clean developer format.

Trait Implementations

impl BackendError for UtilError

type ErrorType = UtilErrorType

fn backtrace(&self) -> Option<&Backtrace>

fn error_type(&self) -> &Self::ErrorType

fn message(&self) -> &str

fn span_trace(&self) -> &SpanTrace

fn location(&self) -> Option<&'static Location<'static>>

Source location where the error was raised, if captured.

fn new_with_traces_and_location<M: Into<String>, S: Into<Option<Error>>>( error_type: Self::ErrorType, message: M, source_error: S, backtrace: Backtrace, span_trace: SpanTrace, location: Option<&'static Location<'static>>, ) -> Self

The one required constructor; the others delegate to it.

fn new<M, S>(error_type: Self::ErrorType, message: M, source_error: S) -> Self

where M: Into<String>, S: Into<Option<Error>>, Self: Sized,

Create an error, capturing the caller’s location, a backtrace and the span trace.

fn new_with_traces<M, S>( error_type: Self::ErrorType, message: M, source_error: S, backtrace: Backtrace, span_trace: SpanTrace, ) -> Self

where M: Into<String>, S: Into<Option<Error>>, Self: Sized,

Like new but with an explicit backtrace and span trace, e.g. to preserve a source error’s traces.

fn to_different_error<T>( self, new_error_type: <T as BackendError>::ErrorType, new_message: String, ) -> T

where T: BackendError, Self: Sized + 'static + Send,

impl Debug for UtilError

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

Formats the value using the given formatter.

impl Display for UtilError

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

Formats the value using the given formatter.

impl Error for UtilError

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 description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

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

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for UtilError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for UtilError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for UtilError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for UtilError

fn from(err: Error) -> UtilError

Converts to this type from the input type.

impl From<ParseError> for UtilError

fn from(source: ParseError) -> Self

Converts to this type from the input type.

impl From<StripPrefixError> for UtilError

fn from(source: StripPrefixError) -> Self

Converts to this type from the input type.