Struct headless_lms_models::error::ModelError

pub struct ModelError {
    error_type: ModelErrorType,
    message: String,
    source: Option<Error>,
    span_trace: SpanTrace,
    backtrace: Backtrace,
}

Error type used by all models. Used as the error type in ModelError, 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 ModelErrorType enum, which is stored inside this struct.

Examples

Usage without source error

if erroneous_condition {
    return Err(ModelError::new(
        ModelErrorType::PreconditionFailed,
        "The user has not enrolled to this course".to_string(),
        None,
    ));
}

Usage with a source error

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

some_function_returning_an_error().map_err(|original_error| {
    ModelError::new(
        ModelErrorType::Generic,
        "Everything went wrong".to_string(),
        Some(original_error.into()),
    )
})?;

Fields

error_type: ModelErrorType

message: String

source: Option<Error>

Original error that caused this error.

span_trace: SpanTrace

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

backtrace: Backtrace

Stack trace, generated automatically when the error is created.

Trait Implementations

impl BackendError for ModelError

type ErrorType = ModelErrorType

fn new( error_type: Self::ErrorType, message: String, source_error: Option<Error>, ) -> Self

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

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

fn message(&self) -> &str

fn span_trace(&self) -> &SpanTrace

fn new_with_traces( error_type: Self::ErrorType, message: String, source_error: Option<Error>, backtrace: Backtrace, span_trace: SpanTrace, ) -> Self

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 ModelError

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

Formats the value using the given formatter.

impl Display for ModelError

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

Formats the value using the given formatter.

impl Error for ModelError

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

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 ModelError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for ModelError

fn from(err: Error) -> ModelError

Converts to this type from the input type.

impl From<Error> for ModelError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<ParseError> for ModelError

fn from(err: ParseError) -> ModelError

Converts to this type from the input type.

impl From<TryFromIntError> for ModelError

fn from(source: TryFromIntError) -> Self

Converts to this type from the input type.

impl From<UtilError> for ModelError

fn from(source: UtilError) -> Self

Converts to this type from the input type.

impl<T> TryToOptional<T, ModelError> for ModelResult<T>

fn optional(self) -> Result<Option<T>, ModelError>