Struct BevyError

pub struct BevyError { /* private fields */ }

The built in “universal” Bevy error type. This has a blanket From impl for any type that implements Rust’s Error, meaning it can be used as a “catch all” error.

Backtraces

When used with the backtrace Cargo feature, it will capture a backtrace when the error is constructed (generally in the From impl]). When printed, the backtrace will be displayed. By default, the backtrace will be trimmed down to filter out noise. To see the full backtrace, set the BEVY_BACKTRACE=full environment variable.

Usage

fn fallible_system() -> Result<(), BevyError> {
    // This will result in Rust's built-in ParseIntError, which will automatically
    // be converted into a BevyError.
    let parsed: usize = "I am not a number".parse()?;
    Ok(())
}

Implementations

impl BevyError

pub fn downcast_ref<E: Error + 'static>(&self) -> Option<&E>

Attempts to downcast the internal error to the given type.

Trait Implementations

impl Debug for BevyError

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

Formats the value using the given formatter.

impl Display for BevyError

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

Formats the value using the given formatter.

impl<E> From<E> for BevyError

where Box<dyn Error + Send + Sync + 'static>: From<E>,

fn from(error: E) -> Self

Converts to this type from the input type.