1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99

//! Conversion method for infallible results
//!
//! This crate provides a convenience trait `UnwrapInfallible`,
//! adding method `unwrap_infallible` to `Result` types where an `Err` variant
//! is statically known to never occur.
//!
//! # Example
//!
//! ```
//! # #![cfg_attr(feature = "never_type", feature(never_type))]
//! #
//! use unwrap_infallible::UnwrapInfallible;
//! # #[cfg(not(feature = "blanket_impl"))]
//! use std::convert::Infallible;
//! # #[cfg(feature = "blanket_impl")]
//! # type Infallible = !;
//!
//! fn always_sunny() -> Result<String, Infallible> {
//!     Ok("it's always sunny!".into())
//! }
//!
//! fn main() {
//!     println!("{}", always_sunny().unwrap_infallible());
//! }
//! ```

#![warn(rust_2018_idioms)]
#![warn(clippy::all)]
#![warn(missing_docs)]
#![no_std]
#![cfg_attr(feature = "never_type", feature(never_type))]

#[cfg(not(feature = "blanket_impl"))]
use core::convert::Infallible;

/// Unwrapping an infallible result into its success value.
pub trait UnwrapInfallible {
    /// Type of the `Ok` variant of the result.
    type Ok;

    /// Unwraps a result, returning the content of an `Ok`.
    ///
    /// Unlike `Result::unwrap`, this method is known to never panic
    /// on the result types it is implemented for. Therefore, it can be used
    /// instead of `unwrap` as a maintainability safeguard that will fail
    /// to compile if the error type of the `Result` is later changed
    /// to an error that can actually occur.
    fn unwrap_infallible(self) -> Self::Ok;
}

#[cfg(feature = "blanket_impl")]
impl<T, E: Into<!>> UnwrapInfallible for Result<T, E> {
    type Ok = T;
    fn unwrap_infallible(self) -> T {
        match self {
            Ok(v) => v,
            Err(e) => e.into(),
        }
    }
}

#[cfg(all(feature = "never_type", not(feature = "blanket_impl")))]
impl<T> UnwrapInfallible for Result<T, !> {
    type Ok = T;
    fn unwrap_infallible(self) -> T {
        self.unwrap_or_else(|never| never)
    }
}

#[cfg(not(feature = "blanket_impl"))]
impl<T> UnwrapInfallible for Result<T, Infallible> {
    type Ok = T;
    fn unwrap_infallible(self) -> T {
        self.unwrap_or_else(|never| match never {})
    }
}

#[cfg(test)]
mod tests {
    use super::UnwrapInfallible;

    // Hmm, Infallible is not Into<!> yet
    #[cfg(not(feature = "blanket_impl"))]
    #[test]
    fn with_infallible() {
        use core::convert::TryFrom;

        let a = 42u8;
        let a = u64::try_from(a).unwrap_infallible();
        assert_eq!(a, 42u64);
    }

    #[cfg(feature = "never_type")]
    #[test]
    fn with_never_type() {
        let r: Result<bool, !> = Ok(true);
        assert!(r.unwrap_infallible());
    }
}