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

// This file is part of Gear.

// Copyright (C) 2023-2024 Gear Technologies Inc.
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0

// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.

//! Actor-system error.
//!
//! Actor is intended to be errors passed to user.
//! System errors are to be unreachable or recoverable.

#![no_std]

/// Define type alias with implemented `From`s.
#[macro_export]
macro_rules! actor_system_error {
    (
        $(#[$($meta:meta)*])?
        $vis:vis type $name:ident = ActorSystemError<$actor_err:ident, $system_err:ident>;
    ) => {
        $(#[$($meta)*])?
        $vis type $name = $crate::ActorSystemError<$actor_err, $system_err>;

        impl From<$actor_err> for $crate::ActorSystemError<$actor_err, $system_err> {
            fn from(err: $actor_err) -> Self {
                Self::Actor(err)
            }
        }

        impl From<$system_err> for $crate::ActorSystemError<$actor_err, $system_err> {
            fn from(err: $system_err) -> Self {
                Self::System(err)
            }
        }
    };
}

/// Actor or system error.
#[derive(Debug, Eq, PartialEq, derive_more::Display)]
pub enum ActorSystemError<A, S> {
    Actor(A),
    System(S),
}

impl<A, S> ActorSystemError<A, S> {
    /// Map actor error.
    pub fn map_actor<F, U>(self, f: F) -> ActorSystemError<U, S>
    where
        F: FnOnce(A) -> U,
    {
        match self {
            Self::Actor(a) => ActorSystemError::Actor(f(a)),
            Self::System(s) => ActorSystemError::System(s),
        }
    }

    /// Map system error.
    pub fn map_system<F, U>(self, f: F) -> ActorSystemError<A, U>
    where
        F: FnOnce(S) -> U,
    {
        match self {
            Self::Actor(a) => ActorSystemError::Actor(a),
            Self::System(s) => ActorSystemError::System(f(s)),
        }
    }

    /// Map actor or system error using [`From::from()`].
    pub fn map_into<UA, US>(self) -> ActorSystemError<UA, US>
    where
        UA: From<A>,
        US: From<S>,
    {
        match self {
            Self::Actor(a) => ActorSystemError::Actor(UA::from(a)),
            Self::System(s) => ActorSystemError::System(US::from(s)),
        }
    }
}

/// Extension for [`Result`] around actor-system error.
pub trait ResultExt<T, A, S> {
    /// Map actor error.
    fn map_actor_err<F, U>(self, f: F) -> Result<T, ActorSystemError<U, S>>
    where
        F: FnOnce(A) -> U;

    /// Map system error.
    fn map_system_err<F, U>(self, f: F) -> Result<T, ActorSystemError<A, U>>
    where
        F: FnOnce(S) -> U;

    /// Map actor or system error.
    fn map_err_into<UA, US>(self) -> Result<T, ActorSystemError<UA, US>>
    where
        UA: From<A>,
        US: From<S>;
}

impl<T, A, S> ResultExt<T, A, S> for Result<T, ActorSystemError<A, S>> {
    fn map_actor_err<F, U>(self, f: F) -> Result<T, ActorSystemError<U, S>>
    where
        F: FnOnce(A) -> U,
    {
        self.map_err(|err| err.map_actor(f))
    }

    fn map_system_err<F, U>(self, f: F) -> Result<T, ActorSystemError<A, U>>
    where
        F: FnOnce(S) -> U,
    {
        self.map_err(|err| err.map_system(f))
    }

    fn map_err_into<UA, US>(self) -> Result<T, ActorSystemError<UA, US>>
    where
        UA: From<A>,
        US: From<S>,
    {
        self.map_err(ActorSystemError::map_into)
    }
}