devela 0.27.0

A development layer of coherence.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

// devela::code::panic::namespace
//
//! Defines the [`Panic`] namespace.
//
// - https://doc.rust-lang.org/stable/std/panic/index.html

#[cfg(feature = "std")]
use crate::{Any, Box, PanicHookInfo, PanicUnwindSafe, ThreadResult};
use ::std::panic::{catch_unwind, panic_any, resume_unwind, set_hook, take_hook};

#[doc = crate::_tags!(namespace)]
/// Panic-related operations.
#[doc = crate::_doc_location!("code/panic")]
#[cfg_attr(nightly_doc, doc(cfg(feature = "std")))]
#[derive(Debug)]
pub struct Panic;

#[cfg(feature = "std")]
#[cfg_attr(nightly_doc, doc(cfg(feature = "std")))]
impl Panic {
    /// Invokes a closure, capturing the cause of an unwinding panic if one occurs.
    ///
    /// See `std::panic::`[`catch_unwind`].
    pub fn catch<F: FnOnce() -> R + PanicUnwindSafe, R>(f: F) -> ThreadResult<R> {
        catch_unwind(f)
    }

    /// Panic the current thread with the given message as the panic payload.
    ///
    /// See `std::panic::`[`panic_any`].
    pub fn any<M: 'static + Any + Send>(msg: M) -> ! {
        panic_any(msg)
    }

    /// Triggers a panic without invoking the panic hook.
    ///
    /// See `std::panic::`[`resume_unwind`].
    pub fn resume(payload: Box<dyn Any + Send>) -> ! {
        resume_unwind(payload)
    }

    /// Registers a custom panic hook, replacing the previously registered hook.
    pub fn set_hook(hook: Box<dyn Fn(&PanicHookInfo<'_>) + Sync + Send + 'static>) {
        set_hook(hook);
    }

    /// Unregisters the current panic hook, returns it and registers.
    pub fn take_hook() -> Box<dyn Fn(&PanicHookInfo<'_>) + Sync + Send + 'static> {
        take_hook()
    }
}