Struct bevy_panic_handler::PanicHandler

pub struct PanicHandler {
    pub custom_title: Arc<dyn PanicHandleFn<String>>,
    pub custom_body: Arc<dyn PanicHandleFn<String>>,
    pub custom_hook: Arc<dyn PanicHandleFn<()>>,
}

Bevy plugin that opens a popup window on panic & logs an error

Fields

custom_title: Arc<dyn PanicHandleFn<String>>

custom_body: Arc<dyn PanicHandleFn<String>>

custom_hook: Arc<dyn PanicHandleFn<()>>

Implementations

impl PanicHandler

pub fn new() -> PanicHandlerBuilder

Create a new builder. The custom hook does nothing.

Examples found in repository

examples/custom_title.rs (line 7)

fn main() {
    App::new()
        .add_plugins(DefaultPlugins)
        .add_plugins(
            bevy_panic_handler::PanicHandler::new()
                .set_title_func(|info| {
                    format!(
                        "Panic at L{}:C{}",
                        info.location().unwrap().line(),
                        info.location().unwrap().column()
                    )
                })
                .build(),
        )
        .add_systems(Startup, || panic!("Example Message"))
        .run();
}

examples/closure.rs (line 10)

fn main() {
    // The path we used to run the executable
    let running_name = std::env::args().next().unwrap();

    App::new()
        .add_plugins(DefaultPlugins)
        .add_plugins(
            bevy_panic_handler::PanicHandler::new()
                .set_call_func(move |_| {
                    println!("Panicked! Arg 1 was: {running_name}");
                })
                .set_body_func(|_| {
                    let mut res_str = String::new();
                    std::io::stdin().read_line(&mut res_str).unwrap();
                    format!("Panicked, also got me a message: {res_str}")
                })
                .build(),
        )
        .add_systems(Startup, || panic!("Example Error. Closures work fine too."))
        .run();
}

examples/custom_body.rs (line 7)

fn main() {
    App::new()
        .add_plugins(DefaultPlugins)
        .add_plugins(
            bevy_panic_handler::PanicHandler::new()
                .set_body_func(|info| {
                    format!(
                        "Panicked at Line {}, Column {}.\nMessage:\n{}",
                        info.location().unwrap().line(),
                        info.location().unwrap().column(),
                        info.payload()
                            .downcast_ref::<String>()
                            .cloned()
                            .unwrap_or_else(|| info
                                .payload()
                                .downcast_ref::<&str>()
                                .unwrap_or(&"")
                                .to_string())
                    )
                })
                .build(),
        )
        .add_systems(Startup, || panic!("Example Message"))
        .run();
}

pub fn new_take_old() -> PanicHandlerBuilder

Create a new builder. The custom hook is taken from std::panic::take_hook()

Examples found in repository

examples/popup.rs (line 6)

fn main() {
    App::new()
        .add_plugins(DefaultPlugins)
        .add_plugins(bevy_panic_handler::PanicHandler::new_take_old().build())
        .add_systems(Startup, || {
            panic!("Example Error.\nNewlines AOK. 😃\n{} too.", "fmt strings")
        })
        .run();
}

Trait Implementations

impl Clone for PanicHandler

fn clone(&self) -> PanicHandler

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Plugin for PanicHandler

fn build(&self, _: &mut App)

Configures the [App] to which this plugin is added.

fn ready(&self, _app: &App) -> bool

Has the plugin finished it’s setup? This can be useful for plugins that needs something asynchronous to happen before they can finish their setup, like renderer initialization. Once the plugin is ready, finish should be called.

fn finish(&self, _app: &mut App)

Finish adding this plugin to the [App], once all plugins registered are ready. This can be useful for plugins that depends on another plugin asynchronous setup, like the renderer.

fn cleanup(&self, _app: &mut App)

Runs after all plugins are built and finished, but before the app schedule is executed. This can be useful if you have some resource that other plugins need during their build step, but after build you want to remove it and send it to another thread.

fn name(&self) -> &str

Configures a name for the [Plugin] which is primarily used for checking plugin uniqueness and debugging.

fn is_unique(&self) -> bool

If the plugin can be meaningfully instantiated several times in an [App], override this method to return false.