Crate dangerous_option [] [src]

This crate provides DangerousOption - a type similar to ! in Swift language. It's basically an Option which panics if dereferenced while containing None. This is useful in cases one needs to initialize things a little bit later or when accesses are made via functions called from trusted library.

While such thing might look like a step back (there's a reason we don't have NULL pointers in Rust), there is still one advantage over classic approach of NULL-pointer exceptions (including manually unwrapping): the cause of the bug is usually not in the place where dereferencing happened but in the place where assignment happened. Since this type has only three, very unique methods for creating invalid value, those can be easily searched for and tracked.

It has alse intentionally long name to prevent over-use. Also the methods creating dangerous state have longer names then those creating valid state.

Note: you should prefer dereferencing the DangerousOption and passing dereferenced value instead of passing the reference to DangerousOption itself. That way you'll decrease chance of making mistake.

Finally, it also provides an exception handler which allows customizing panic message, logging, etc. There is a default handler which just panics, but in contexts where there is a more concrete, known cause of invalid operation, overriding the message is encouraged.

This crate is no_std.

Structs

DangerousOption

Represents a value that migt be uninitialized, but most probably isn't. It provides convenient acces to the value via Deref while checking whether the value is actually initialized.

Enums

DefaultExceptionHandler

This is the default handler for None exceptions.

Traits

ExceptionHandler

The exception handler defining behavior in case None is accessed.