unchecked_unwrap

Release:

Master:

Adds an unchecked version of unwrap() and expect() to Option and Result for the rust programming language. Supports no_std.

Branches

• release - For releases only.
• master - For active development, PR's and testing.

Usage

```rust use unchecked_unwrap::*;

let x = Some("air"); asserteq!(unsafe { x.uncheckedunwrap() }, "air");

let x: Result = Ok(2); asserteq!(unsafe { x.uncheckedunwrap() }, 2);

let x = Some("value"); asserteq!(unsafe { x.uncheckedexpect("the world is ending") }, "value");

let x: Result = Ok(2); asserteq!(unsafe { x.uncheckedexpect("the sky is falling down") }, 2); ```

Crate features

• debug_checks - On by default. Enables the normal checking behavior with panics when debug-assertions is enabled.
• nightly
  • Enables full documentation through feature(external_doc).
  • Enables benchmarking through feature(test).
  • Enables implicit caller location through feature(track_caller).

Documentation

Documentation is available online in the badge links above. Currently, nightly is needed for full documentation: cargo doc --features nightly If you are not using nightly, use cargo doc as usual.

Tests

Is as simple as cargo test and cargo test --release.

Benchmarking

Is as simple as cargo bench. Currently the nightly version of rust and the feature="nightly" is needed for benchmarking.

CI

This crate is checked daily by CI to make sure that it builds successfully with the newest versions of rust stable, beta and nightly.

Alternatives

• unsafe-unwrap-rs -
• unsafe-unwrap

License

This work is dual-licensed under MIT and Apache 2.0. You can choose between one of them if you use this work.

See the LICENSE file for details

SPDX-License-Identifier: MIT OR Apache-2.0