From 9eec9ab94bbe5c9fbd52d5bbf393fe1ddcc6fc26 Mon Sep 17 00:00:00 2001 From: Mica White Date: Thu, 26 Dec 2024 12:06:47 -0500 Subject: Documentation --- src/handle_unwind.rs | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'src/handle_unwind.rs') diff --git a/src/handle_unwind.rs b/src/handle_unwind.rs index 220d379..42b6fc5 100644 --- a/src/handle_unwind.rs +++ b/src/handle_unwind.rs @@ -1,6 +1,9 @@ use std::panic::{catch_unwind, resume_unwind, AssertUnwindSafe}; -/// Runs `try_fn`. If it unwinds, it will run `catch` and then continue unwinding +/// Runs `try_fn`. If it unwinds, it will run `catch` and then continue +/// unwinding. This is used instead of `scopeguard` to ensure the `catch` +/// function doesn't run if the thread is already panicking. The unwind +/// must specifically be caused by the `try_fn` pub fn handle_unwind R, G: FnOnce()>(try_fn: F, catch: G) -> R { let try_fn = AssertUnwindSafe(try_fn); catch_unwind(try_fn).unwrap_or_else(|e| { -- cgit v1.2.3