microseh 0.1.1 - Docs.rs

docs.rs failed to build microseh-0.1.1
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.

Visit the last successful build: microseh-1.1.2

MicroSEH is a small library for Structured Exception Handling (SEH) in Rust that can catch and handle hardware exceptions.

Isn't Rust supposed to be safe? Well, yes, but as soon as you enter the unsafe world, you can do anything you want.

Having a way to handle hardware exceptions is useful, especially when you're interfacing with other C binaries. There may be some cases where a hardware exception is not a fatal error, and can be resolved by the program.

The most basic application of such concept is to catch a segmentation fault when accessing an invalid pointer.

Implementation

It turns out that implementing SEH in safe Rust may not look that straightforward at first glance (as seen in this post)

This library uses a different, simpler approach, which is to use a C stub that calls back into Rust, wrapping the call in a __try __except block.

Usage

Add this to your Cargo.toml:

[dependencies]
microseh = "0.1"

Example: De-referencing a null pointer without crashing the program.

fn guarded() -> Result<(), Box<dyn Error>> {
    microseh::try_seh(|| {
        *std::ptr::null::<i32>();
    })?;
}

Portability

SEH is a Microsoft extension to the C language, so it's only available on Windows with MSVC.