acktor 1.0.16

Pure-Rust actor framework built on top of the Tokio async runtime
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

use crate::actor::Actor;
use crate::channel::{mpsc, oneshot};
use crate::envelope::{Envelope, IntoEnvelope};
use crate::message::Message;

/// Permit to send one message to an actor.
#[derive(Debug)]
pub struct SendPermit<'a, A>
where
    A: Actor,
{
    pub(super) permit: mpsc::Permit<'a, Envelope<A>>,
}

impl<A> SendPermit<'_, A>
where
    A: Actor,
{
    /// Sends a message using the permit and returns a
    /// [`Receiver`][crate::channel::oneshot::Receiver] which can be used to receive the message
    /// response.
    ///
    /// This method will consume the permit.
    pub fn send<M, EP>(self, msg: M) -> oneshot::Receiver<M::Result>
    where
        M: Message + IntoEnvelope<A, EP>,
    {
        let (tx, rx) = oneshot::channel();
        self.permit.send(msg.pack(Some(tx)));
        rx
    }

    /// Sends a message using the permit without expecting a response.
    ///
    /// This method will consume the permit.
    pub fn do_send<M, EP>(self, msg: M)
    where
        M: Message + IntoEnvelope<A, EP>,
    {
        self.permit.send(msg.pack(None));
    }
}

/// Owned permit to send one message to an actor.
#[derive(Debug)]
pub struct OwnedSendPermit<A>
where
    A: Actor,
{
    pub(super) permit: mpsc::OwnedPermit<Envelope<A>>,
}

impl<A> OwnedSendPermit<A>
where
    A: Actor,
{
    /// Sends a message using the permit and returns a
    /// [`Receiver`][crate::channel::oneshot::Receiver] which can be used to receive the message
    /// response.
    ///
    /// This method will consume the permit.
    pub fn send<M, EP>(self, msg: M) -> oneshot::Receiver<M::Result>
    where
        M: Message + IntoEnvelope<A, EP>,
    {
        let (tx, rx) = oneshot::channel();
        self.permit.send(msg.pack(Some(tx)));
        rx
    }

    /// Sends a message using the permit without expecting a response.
    ///
    /// This method will consume the permit.
    pub fn do_send<M, EP>(self, msg: M)
    where
        M: Message + IntoEnvelope<A, EP>,
    {
        self.permit.send(msg.pack(None));
    }
}

#[cfg(test)]
mod tests {
    use anyhow::Result;
    use pretty_assertions::assert_eq;

    use crate::error::SendError;
    use crate::test_utils::{Ping, make_address};

    #[tokio::test]
    async fn test_permit() -> Result<()> {
        // reserve
        let (a1, m1) = make_address(2);
        let permit = a1.reserve().await?;
        permit.do_send(Ping(1));
        let permit = a1.try_reserve()?;
        permit.send(Ping(2));
        assert_eq!(m1.len(), 2);

        // capacity
        let (a1, m1) = make_address(2);
        let p1 = a1.reserve().await?;
        let _p2 = a1.reserve().await?;
        let result = a1.try_reserve();
        assert!(
            matches!(result, Err(SendError::Full(_))),
            "expected Full, got {result:?}"
        );

        // drop a permit releases the slot
        drop(p1);
        let _ = a1.try_reserve()?;

        // close
        drop(m1);
        let result = a1.try_reserve();
        assert!(
            matches!(result, Err(SendError::Closed(_))),
            "expected Closed, got {result:?}"
        );

        // reserve_owned
        let (a1, m1) = make_address(2);
        let permit = a1.reserve_owned().await?;
        permit.do_send(Ping(2));
        let permit = a1.try_reserve_owned()?;
        permit.send(Ping(3));
        assert_eq!(m1.len(), 2);

        // capacity
        let (a1, m1) = make_address(2);
        let p1 = a1.reserve_owned().await?;
        let _p2 = a1.reserve_owned().await?;
        let result = a1.try_reserve_owned();
        assert!(
            matches!(result, Err(SendError::Full(_))),
            "expected Full, got {result:?}"
        );

        // drop a permit releases the slot
        drop(p1);
        let _ = a1.try_reserve_owned()?;

        // close
        drop(m1);
        let result = a1.try_reserve_owned();
        assert!(
            matches!(result, Err(SendError::Closed(_))),
            "expected Closed, got {result:?}"
        );

        Ok(())
    }
}