Enum RtbError 

#[non_exhaustive]
pub enum RtbError {
    Config(String),
    Io(Error),
    CommandNotFound(String),
    FeatureDisabled(&'static str),
    Other(Box<dyn Diagnostic + Sync + Send>),
}

Umbrella error enum for the framework.

Downstream crates should define their own #[derive(Error, Diagnostic)] enums and convert at the boundary. This enum captures only the errors raised by the application scaffolding itself, plus the Error::Other escape hatch for downstream typed diagnostics.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Config(String)

Configuration source rejected the value.

Io(Error)

Filesystem or network I/O.

CommandNotFound(String)

No registered command matches the user-supplied name.

FeatureDisabled(&'static str)

A built-in command was requested but its Cargo feature is off.

Other(Box<dyn Diagnostic + Sync + Send>)

A downstream crate’s typed diagnostic, kept live for rendering.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Diagnostic for Error

fn code(&self) -> Option<Box<dyn Display + '_>>

Unique diagnostic code that can be used to look up more information about this Diagnostic. Ideally also globally unique, and documented in the toplevel crate’s documentation for easy searching. Rust path format (foo::bar::baz) is recommended, but more classic codes like E0123 or enums will work just fine.

fn help(&self) -> Option<Box<dyn Display + '_>>

Additional help text related to this Diagnostic. Do you have any advice for the poor soul who’s just run into this issue?

fn severity(&self) -> Option<Severity>

Diagnostic severity. This may be used by ReportHandlers to change the display format of this diagnostic.

fn labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan> + '_>>

Labels to apply to this Diagnostic’s Diagnostic::source_code

fn source_code(&self) -> Option<&dyn SourceCode>

Source code to apply this Diagnostic’s Diagnostic::labels to.

fn related(&self) -> Option<Box<dyn Iterator<Item = &dyn Diagnostic> + '_>>

Additional related Diagnostics.

fn url(&self) -> Option<Box<dyn Display + '_>>

URL to visit for a more detailed explanation/help about this Diagnostic.

fn diagnostic_source(&self) -> Option<&dyn Diagnostic>

The cause of the error.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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

Returns 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 From<Box<dyn Diagnostic + Sync + Send>> for Error

fn from(source: Box<dyn Diagnostic + Sync + Send>) -> Error

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Error

Converts to this type from the input type.