try_v2 0.7.4

Provides a derive macro & helper traits for `Try`
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
98
99
100
101
102
103
104
105

use std::{
    fmt::Debug,
    ops::{ControlFlow, Try},
};

/// Methods for extracting the wrapped value
pub trait Extract<T>
where
    Self: Try<Output = T> + Sized,
{
    /// Extracts the contained value `v` returning `Some(v)`, or `None` in the case of a Residual
    ///
    /// Think of this as the non-panicking version of `unwrap()`
    fn output(self) -> Option<T> {
        match self.branch() {
            ControlFlow::Continue(val) => Some(val),
            ControlFlow::Break(_) => None,
        }
    }

    /// Return the contained value or panic with a generic message.
    ///
    /// In general you should prefer `expect()` for panic situations or `output()` for non-panic
    ///
    /// # Note to implementors
    /// - the provided implementation uses [`Extract::expect`]. Implementors should prefer
    ///   customising `expect` to directly customising `unwrap`.
    fn unwrap(self) -> T
    where
        Self::Residual: Debug,
    {
        self.expect("called `unwrap()` on a residual:")
    }

    /// Return the contained value or panic with a custom message.
    ///
    /// In general you should prefer `output()` or `?` which do not panic.
    fn expect(self, msg: &str) -> T
    where
        Self::Residual: Debug,
    {
        match self.branch() {
            ControlFlow::Continue(v) => v,
            #[cfg(not(panic = "immediate-abort"))]
            ControlFlow::Break(r) => panic!("{msg}: {r:?}"),
            #[cfg(panic = "immediate-abort")]
            ControlFlow::Break(_) => panic!(),
        }
    }

    /// Return the contained value or the given default.
    ///
    /// Arguments passed to unwrap_or are eagerly evaluated; if you are passing the result of a
    /// function call, it is recommended to use unwrap_or_else, which is lazily evaluated.
    ///
    /// # Note to implementors
    /// - the provided implementation uses [`Extract::unwrap_or_else`]. Implementors should prefer
    ///   customising `unwrap_or_else` to directly customising `unwrap_or`.
    fn unwrap_or(self, default: T) -> T {
        self.unwrap_or_else(|| default)
    }

    /// Return the contained value or a default. Requires `T` to implement `Default`
    ///
    /// # Note to implementors
    /// - the provided implementation uses [`Extract::unwrap_or_else`]. Implementors should prefer
    ///   customising `unwrap_or_else` to directly customising `unwrap_or_default`.
    fn unwrap_or_default(self) -> T
    where
        T: Default,
    {
        self.unwrap_or_else(Default::default)
    }

    /// Return the contained value or a value computed from a closure.
    fn unwrap_or_else<F>(self, f: F) -> T
    where
        F: FnOnce() -> T,
    {
        match self.branch() {
            ControlFlow::Continue(v) => v,
            ControlFlow::Break(_) => f(),
        }
    }
}

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

    impl<T> Extract<T> for Option<T> {}
    impl<T, E> Extract<T> for Result<T, E> {}

    mod output {
        use super::*;

        #[test]
        fn ok() {
            let ok_5: Result<_, ()> = Ok(5);
            let stdlib = ok_5.ok();
            let custom = ok_5.output();
            assert_eq!(stdlib, custom);
        }
    }
}