zestors 0.1.2

A fast and flexible actor-framework for building fault-tolerant Rust applications
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205

#[allow(unused)]
use crate::all::*;
use std::sync::Arc;

/// Any message should implement [`Message`], and has two associated types:
/// - [`Message::Payload`] -> The payload of the message that is sent to the actor.
/// - [`Message::Returned`] -> The value that is returned when the message is sent.
///
/// A simple message has the following associated types:
/// - `Payload = Self`
/// - `Returned = ()`
///
/// A request of type `R` has the following associated types:
/// - `Payload = (Self, Tx<R>)`
/// - `Returned = Rx<R>`
///
/// # Derive
/// [`Message`] can be derived with the [`derive@Message`] macro.
pub trait Message: Sized {
    ///  The payload of the message that is sent to the actor.
    type Payload: Send + 'static;

    /// The value that is returned when the message is sent.
    type Returned;

    /// This is called before the message is sent.
    fn create(self) -> (Self::Payload, Self::Returned);

    /// This is called if the message cannot be sent.
    fn cancel(sent: Self::Payload, returned: Self::Returned) -> Self;
}

/// A version of the [`Message`] trait generic over `M`, used as the `[msg(..)]` attribute for the [`derive@Message`] derive
/// macro.
/// 
/// This is implemented for `()`, [`Rx<_>`] and [`Tx<_>`]
pub trait MessageDerive<M> {
    /// See [`Message::Payload`].
    type Payload;

    /// See [`Message::Returned`].
    type Returned;

    /// See [`Message::create`].
    fn create(msg: M) -> (Self::Payload, Self::Returned);

    /// See [`Message::cancel`].
    fn cancel(sent: Self::Payload, returned: Self::Returned) -> M;
}

impl<M: Send + 'static> MessageDerive<M> for () {
    type Payload = M;
    type Returned = ();
    fn create(msg: M) -> (M, ()) {
        (msg, ())
    }
    fn cancel(payload: M, _returns: ()) -> M {
        payload
    }
}

//------------------------------------------------------------------------------------------------
//  Message: Default implementations
//------------------------------------------------------------------------------------------------

macro_rules! implement_message_for_base_types {
    ($(
        $ty:ty
    ),*) => {
        $(
            impl Message for $ty {
                type Payload = Self;
                type Returned = ();
                fn create(self) -> (Self, ()) {
                    (self, ())
                }
                fn cancel(payload: Self, _returns: ()) -> Self {
                    payload
                }
            }
        )*
    };
}
implement_message_for_base_types! {
    u8, u16, u32, u64, u128,
    i8, i16, i32, i64, i128,
    (),
    String, &'static str
}

macro_rules! implement_message_for_wrappers {
    ($(
        $wrapper:ty
        $(where $_:ty: $where:ident)*
    ,)*) => {
        $(
            impl<M> Message for $wrapper
                where M: SimpleMessage + Send + 'static + $($where +)*
            {
                type Payload = Self;
                type Returned = ();
                fn create(self) -> (Self, ()) {
                    (self, ())
                }
                fn cancel(payload: Self, _returns: ()) -> Self {
                    payload
                }
            }
        )*
    };
}
implement_message_for_wrappers!(
    Box<M>,
    Arc<M> where M: Sync,
    Vec<M>,
    Box<[M]>,
);

macro_rules! implement_message_kind_and_message_for_tuples {
    ($(
        ($($id:ident: $na:ident + $na2:ident),*),
    )*) => {
        $(
            impl<$($id),*> Message for ($($id,)*)
            where
                $($id: SimpleMessage + Send + 'static,)*
            {
                type Payload = Self;
                type Returned = ();
                fn create(self) -> (Self, ()) {
                    (self, ())
                }
                fn cancel(payload: Self, _returns: ()) -> Self {
                    payload
                }
            }
        )*
    };
}
implement_message_kind_and_message_for_tuples!(
    (M1: m1 + m_1),
    (M1: m1 + m_1, M2: m2 + m_2),
    (M1: m1 + m_1, M2: m2 + m_2, M3: m3 + m_3),
    (M1: m1 + m_1, M2: m2 + m_2, M3: m3 + m_3, M4: m4 + m_4),
    (
        M1: m1 + m_1,
        M2: m2 + m_2,
        M3: m3 + m_3,
        M4: m4 + m_4,
        M5: m5 + m_5
    ),
    (
        M1: m1 + m_1,
        M2: m2 + m_2,
        M3: m3 + m_3,
        M4: m4 + m_4,
        M5: m5 + m_5,
        M6: m6 + m_6
    ),
    (
        M1: m1 + m_1,
        M2: m2 + m_2,
        M3: m3 + m_3,
        M4: m4 + m_4,
        M5: m5 + m_5,
        M6: m6 + m_6,
        M7: m7 + m_7
    ),
    (
        M1: m1 + m_1,
        M2: m2 + m_2,
        M3: m3 + m_3,
        M4: m4 + m_4,
        M5: m5 + m_5,
        M6: m6 + m_6,
        M7: m7 + m_7,
        M8: m8 + m_8
    ),
    (
        M1: m1 + m_1,
        M2: m2 + m_2,
        M3: m3 + m_3,
        M4: m4 + m_4,
        M5: m5 + m_5,
        M6: m6 + m_6,
        M7: m7 + m_7,
        M8: m8 + m_8,
        M9: m9 + m_9
    ),
    (
        M1: m1 + m_1,
        M2: m2 + m_2,
        M3: m3 + m_3,
        M4: m4 + m_4,
        M5: m5 + m_5,
        M6: m6 + m_6,
        M7: m7 + m_7,
        M8: m8 + m_8,
        M9: m9 + m_9,
        M10: m10 + m_10
    ),
);

trait SimpleMessage: Message<Payload = Self, Returned = ()> {}
impl<T> SimpleMessage for T where T: Message<Payload = Self, Returned = ()> {}