Trait bevy_mod_sysfail::FailureMode

pub trait FailureMode {
    type ID: Hash + Eq;

    fn log_level(&self) -> LogLevel;
    fn identify(&self) -> Self::ID;
    fn display(&self) -> Option<String>;

    fn cooldown(&self) -> Duration { ... }
    fn log(&self) { ... }
}

Something that can be logged in a sysfail handler

Required Associated Types

type ID: Hash + Eq

Used to de-duplicate identical messages to avoid spamming the log.

Required Methods

fn log_level(&self) -> LogLevel

The log level of specific values.

fn identify(&self) -> Self::ID

What constitutes “distinct” error types.

fn display(&self) -> Option<String>

What to log, the default FailureMode::log impl does nothing if None.

Provided Methods

fn cooldown(&self) -> Duration

How long an error must not be produced in order to be displayed again.

This controls when FailureMode::log is called.

Return Duration::ZERO to trigger FailureMode::log each time there is an error.

fn log(&self)

What happens, by default this logs based on the return value of FailureMode::log_level.

Examples

https://crates.io/crates/bevy_debug_text_overlay provides a wrapper struct to replace log-printing with displaying errors on screen.

Implementations on Foreign Types

impl FailureMode for ()

fn log_level(&self) -> LogLevel

type ID = ()

fn identify(&self)

fn display(&self) -> Option<String>

impl FailureMode for &'static str

fn log_level(&self) -> LogLevel

type ID = &'static str

fn identify(&self) -> Self

fn display(&self) -> Option<String>

impl FailureMode for Box<dyn Error>

fn identify(&self)

By default, only print a single error per system.

fn log_level(&self) -> LogLevel

type ID = ()

fn display(&self) -> Option<String>

impl FailureMode for Error

fn identify(&self)

By default, only print a single error per system.

fn log_level(&self) -> LogLevel

type ID = ()

fn display(&self) -> Option<String>

Implementors

impl<T: FailureMode> FailureMode for OverrideLevel<T>

type ID = <T as FailureMode>::ID