Struct Bug

pub struct Bug {
    pub source: Option<Box<dyn StdError>>,
    /* private fields */
}

Wrapper for errors that should not happen but cannot panic. It is wrapped in the Error::Bug variant.

To generate it from predicates use Bug::new, from Result or Option import the prelude and use either bug(), bug_with_source(), bug_force(), bug_force_with_source()

Fields

source: Option<Box<dyn StdError>>

Implementations

impl Bug

pub fn new() -> Self

Usefull to generate a Bug when a predicate is not met.

Examples

if 1 < 2 {
    Err(Bug::new())?;
}

pub fn with_source<E: StdError + 'static>(self, error: E) -> Self

Add an error source to a Bug. Usefull to generate a bug when pattern matching on an error type.

On a Result use map_err_or_bug to be more concise.

Examples

fn fetch() -> Result<()> {
    let sqlx_error = sqlx::Error::RowNotFound;
    Err(match sqlx_error {
        sqlx::Error::RowNotFound => MyEntitysError::NotFound.into(),
        _ => Bug::new().with_source(sqlx_error).into()
    })
}

pub fn with_context(self, context: impl Display) -> Self

Add context to a Bug, override if one was set. The context appears in display but not in the http response.

Examples

if 1 < 2 {
    Err(Bug::new().with_context("Some info to help debug"))?;
}

pub fn new_force() -> Self

Force backtrace capture using force_capture

Examples

if 1 < 2 {
    Err(Bug::new_force())?;
}

Trait Implementations

impl Debug for Bug

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

Formats the value using the given formatter.

impl Default for Bug

fn default() -> Self

Returns the “default value” for a type.

impl Display for Bug

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

Formats the value using the given formatter.

impl Error for Bug

fn source(&self) -> Option<&(dyn StdError + '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<D> From<Bug> for Error<D>

where D: Domain,

fn from(value: Bug) -> Self

Converts to this type from the input type.

impl Serialize for Bug

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

where __S: Serializer,

Serialize this value into the given Serde serializer.