debug_unwrap 1.0.3

Adds the method debug_unwrap for when you just want to make it compile.
Documentation 
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

//! Adds the method debug_unwrap for when you just want to make it compile.
//! Not to be confused with the <https://crates.io/crates/debug_unwraps> crate.
//! 
//! This library adds the [DebugUnwrap](DebugUnwrap) extension trait that adds
//! the method [debug_unwrap](DebugUnwrap::debug_unwrap) to the
//! [Option](std::option::Option) and [Result](std::result::Result) types.
//! It does exactly the same thing as the normal unwrap methods, but won't exist
//! when compiling without debug_assertions enabled
//! (i.e. when not compiling in Debug mode).
//! 
//! There is also three other aliases that all have there respective
//! library features of the same name to enable them:
//!  - out (enabled by default)
//!  - o
//!  - peel
//!
//! You can also use the `deprecate` feature which makes the functions deprecated
//! on release mode instead of flat out not existing, so that your code will
//! compile but with warnings.
use std::fmt::Debug;

/// Extension trait for the Result and Option types, see crate-level
/// documentation for more information.
pub trait DebugUnwrap: Sized {
    type Output;

    /// The same as [Option::unwrap](Option::unwrap) on Options or
    /// [Result::unwrap](Result::unwrap) on Results but only exists in Debug mode.
    ///
    /// See crate-level documentation for more information.
    #[cfg(any(debug_assertions, feature="deprecate"))]
    #[cfg_attr(
        all(not(debug_assertions), feature = "deprecate"),
        deprecated = "Debug unwrap must not be used in release mode"
    )]
    fn debug_unwrap(self) -> Self::Output;

    /// Alias for [debug_unwrap](DebugUnwrap::debug_unwrap).
    /// Enabled by the feature `out` (enabled by default).
    ///
    /// See crate-level documentation for more information.
    #[cfg(all(any(debug_assertions, feature="deprecate"), feature="out"))]
    #[cfg_attr(
        all(not(debug_assertions), feature = "deprecate"),
        deprecated = "Debug unwrap must not be used in release mode"
    )]
    fn out(self) -> Self::Output {
        #[allow(deprecated)]
        self.debug_unwrap()
    }

    /// Alias for [debug_unwrap](DebugUnwrap::debug_unwrap).
    /// Enabled by the feature `o`.
    ///
    /// See crate-level documentation for more information.
    #[cfg(all(any(debug_assertions, feature="deprecate"), feature="o"))]
    #[cfg_attr(
        all(not(debug_assertions), feature = "deprecate"),
        deprecated = "Debug unwrap must not be used in release mode"
    )]
    fn o(self) -> Self::Output {
        #[allow(deprecated)]
        self.debug_unwrap()
    }

    /// Alias for [debug_unwrap](DebugUnwrap::debug_unwrap).
    /// Enabled by the feature `peel`.
    ///
    /// See crate-level documentation for more information.
    #[cfg(all(any(debug_assertions, feature="deprecate"), feature="peel"))]
    #[cfg_attr(
        all(not(debug_assertions), feature = "deprecate"),
        deprecated = "Debug unwrap must not be used in release mode"
    )]
    fn peel(self) -> Self::Output {
        #[allow(deprecated)]
        self.debug_unwrap()
    }
}

impl<T: Sized> DebugUnwrap for Option<T> {
    type Output = T;

    #[cfg(any(debug_assertions, feature="deprecate"))]
    fn debug_unwrap(self) -> T {
        self.unwrap()
    }
}

impl<T: Sized, E: Debug> DebugUnwrap for Result<T, E> {
    type Output = T;

    #[cfg(any(debug_assertions, feature="deprecate"))]
    fn debug_unwrap(self) -> T {
        self.unwrap()
    }
}