mkutils 0.1.151

Utility methods, traits, and types.
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142

use crate::utils::Utils;
use derive_more::IsVariant;
use std::{
    convert::Infallible,
    ops::{ControlFlow, FromResidual, Residual, Try},
};

#[derive(Debug, IsVariant)]
pub enum Output<T, E> {
    Ok(T),
    EndOk,
    EndErr(E),
}

impl<T, E> Output<T, E> {
    pub fn into_option(self) -> Option<Result<T, E>> {
        match self {
            Self::Ok(ok) => ok.ok().some(),
            Self::EndOk => None,
            Self::EndErr(err) => err.err().some(),
        }
    }

    pub fn into_control_flow(self) -> ControlFlow<Output<Infallible, E>, T> {
        match self {
            Self::Ok(ok) => ok.into_continue(),
            Self::EndOk => Output::EndOk.into_break(),
            Self::EndErr(err) => err.end_err().into_break(),
        }
    }

    pub fn into_end(self) -> Option<Result<(), E>> {
        match self {
            Self::Ok(_ok) => None,
            Self::EndOk => ().ok().some(),
            Self::EndErr(err) => err.err().some(),
        }
    }
}

impl<T: Default, E> Output<T, E> {
    pub fn into_result(self) -> Result<T, E> {
        match self {
            Self::Ok(ok) => ok.ok(),
            Self::EndOk => T::default().ok(),
            Self::EndErr(err) => err.err(),
        }
    }
}

impl<T, E> From<T> for Output<T, E> {
    fn from(ok: T) -> Self {
        Self::Ok(ok)
    }
}

impl<T, E> From<Option<T>> for Output<T, E> {
    fn from(option: Option<T>) -> Self {
        if let Some(ok) = option {
            Self::Ok(ok)
        } else {
            Self::EndOk
        }
    }
}

impl<T, E> From<Option<Result<T, E>>> for Output<T, E> {
    fn from(opt_res: Option<Result<T, E>>) -> Self {
        match opt_res {
            Some(Ok(ok)) => Self::Ok(ok),
            Some(Err(err)) => Self::EndErr(err),
            None => Self::EndOk,
        }
    }
}

impl<T, E> From<Result<T, E>> for Output<T, E> {
    fn from(result: Result<T, E>) -> Self {
        match result {
            Ok(ok) => Self::Ok(ok),
            Err(err) => Self::EndErr(err),
        }
    }
}

impl<T, E> Residual<T> for Output<Infallible, E> {
    type TryType = Output<T, E>;
}

impl<T, E> Try for Output<T, E> {
    type Output = T;
    type Residual = Output<Infallible, E>;

    fn from_output(output: Self::Output) -> Self {
        output.into()
    }

    fn branch(self) -> ControlFlow<Self::Residual, Self::Output> {
        self.into_control_flow()
    }
}

// NOTE:
// - enables the question mark operator to be applied to [Output<_, E2>]
//   when the enclosing function's return value is [Output<T, E>]
// - [Output<T, E>: FromResidual<<Output<T, E> as Try>::Residual>] is a
//   required implementation per
//   [https://doc.rust-lang.org/stable/std/ops/trait.FromResidual.html]
//   and is a specific case of the below impl when [E = E2]
// - [<Output<_, E2> as Try>::Residual = Output<Infallible, E2>] per above
impl<T, E2, E: From<E2>> FromResidual<Output<Infallible, E2>> for Output<T, E> {
    fn from_residual(residual: Output<Infallible, E2>) -> Self {
        match residual {
            Output::EndOk => Self::EndOk,
            Output::EndErr(err) => err.convert::<E>().end_err(),
        }
    }
}

// NOTE:
// - enables the question mark operator to be applied to [Result<_, E2>]
//   when the enclosing function's return value is [Output<T, E>]
// - [<Result<_, E2> as Try>::Residual = Result<Infallible, E2>] per
//   [https://doc.rust-lang.org/stable/std/result/enum.Result.html#associatedtype.Residual]
impl<T, E2, E: From<E2>> FromResidual<Result<Infallible, E2>> for Output<T, E> {
    fn from_residual(residual: Result<Infallible, E2>) -> Self {
        match residual {
            Err(err) => err.convert::<E>().end_err(),
        }
    }
}

// NOTE:
// - enables the question mark operator to be applied to [Option<_>] when
//   the enclosing function's return value is [Output<T, E>]
// - [<Option<_> as Try>::Residual = Option<Infallible>] per
//   [https://doc.rust-lang.org/stable/std/option/enum.Option.html#associatedtype.Residual]
impl<T, E> FromResidual<Option<Infallible>> for Output<T, E> {
    fn from_residual(_residual: Option<Infallible>) -> Self {
        Self::EndOk
    }
}