Function sgx_tstd::panic::catch_unwind [−][src]
pub fn catch_unwind<F: FnOnce() -> R + UnwindSafe, R>(
f: F
) -> Result<R, Box<Any + Send + 'static>>
Invokes a closure, capturing the cause of an unwinding panic if one occurs.
This function will return Ok
with the closure's result if the closure
does not panic, and will return Err(cause)
if the closure panics. The
cause
returned is the object with which panic was originally invoked.
It is currently undefined behavior to unwind from Rust code into foreign code, so this function is particularly useful when Rust is called from another language (normally C). This can run arbitrary Rust code, capturing a panic and allowing a graceful handling of the error.
It is not recommended to use this function for a general try/catch
mechanism. The Result
type is more appropriate to use for functions that
can fail on a regular basis. Additionally, this function is not guaranteed
to catch all panics, see the "Notes" section below.
The closure provided is required to adhere to the UnwindSafe
trait to ensure
that all captured variables are safe to cross this boundary. The purpose of
this bound is to encode the concept of exception safety in the type
system. Most usage of this function should not need to worry about this
bound as programs are naturally unwind safe without unsafe
code. If it
becomes a problem the associated AssertUnwindSafe
wrapper type in this
module can be used to quickly assert that the usage here is indeed unwind
safe.
Notes
Note that this function may not catch all panics in Rust. A panic in Rust is not always implemented via unwinding, but can be implemented by aborting the process as well. This function only catches unwinding panics, not those that abort the process.