Browse Source

Properly document safety concerns

pull/162/head
Fenrir 10 months ago
parent
commit
d32cd1525f
  1. 4
      ctru-rs/src/applets/error.rs

4
ctru-rs/src/applets/error.rs

@ -82,7 +82,9 @@ impl PopUp {
/// Sets a custom panic hook that uses the error applet to display panic messages. You can also choose to have /// Sets a custom panic hook that uses the error applet to display panic messages. You can also choose to have
/// messages printed over stderr along with the pop-up display. /// messages printed over stderr along with the pop-up display.
/// ///
/// SAFETY: The error applet requires that both the [`Apt`] and [`Gfx`] services are active whenever it launches. /// # Safety
///
/// The error applet requires that both the [`Apt`] and [`Gfx`] services are active whenever it launches.
/// By calling this function, you promise that you will keep those services alive until either the program ends or /// By calling this function, you promise that you will keep those services alive until either the program ends or
/// you unregister this hook with [`std::panic::take_hook`](https://doc.rust-lang.org/std/panic/fn.take_hook.html). /// you unregister this hook with [`std::panic::take_hook`](https://doc.rust-lang.org/std/panic/fn.take_hook.html).
pub unsafe fn set_panic_hook(use_stderr: bool) { pub unsafe fn set_panic_hook(use_stderr: bool) {

Loading…
Cancel
Save