fluxion 0.10.5

Fluxion is an actor framework written in rust and designed for distributed systems.
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

//! # References
//! [`ActorRef`]s, or Actor References, are the primary method through which actors control each other.




use crate::{Actor, ActorWrapper, Delegate, Handler, Message, MessageSendError};
use alloc::boxed::Box;

/// # [`ActorRef`]
/// This trait provides methods for actors to communicate with and control each other.
pub trait ActorRef<A: Actor> {}

/// # [`MessageSender`]
/// This trait provides the ability to send a specific message type to a specific actor.
/// This trait is only necessary because traits with generic methods are not object safe,
/// and we need a way to be generic over multiple types of [`ActorRef`] at once.
/// Sadly, [`async_trait`] is also required for this trait as async fns in traits are not yet object safe either.
#[async_trait::async_trait]
pub trait MessageSender<M: Message>: Send + Sync + 'static {


    /// Sends the given message and waits for a response.
    /// 
    /// # Errors
    /// This may return an error (defined as an associated type) if the message's send fails.
    /// For [`LocalRef`], the message send will never fail, however delegates may return an error upon sending.
    /// These errors are generally not recoverable, and should be interpreted as meaning that the
    /// target actor no longer exists/is no longer accessible.
    async fn send(&self, message: M) -> Result<M::Result, MessageSendError>;
}


pub struct LocalRef<A: Actor, D: Delegate>(pub(crate) slacktor::ActorHandle<ActorWrapper<A, D>>, pub(crate) u64);

impl<A: Actor, D: Delegate> LocalRef<A, D> {
    /// # [`LocalRef::get_id`]
    /// Retrieves the actor's ID
    #[must_use]
    pub fn get_id(&self) -> u64 {
        self.1
    }
}

impl<A: Actor, D: Delegate> Clone for LocalRef<A, D> {
    fn clone(&self) -> Self {
        Self(self.0.clone(), self.1)
    }
}

#[async_trait::async_trait]
impl<A: Handler<M>, M: Message, D: Delegate> MessageSender<M> for LocalRef<A, D> {

    #[inline]
    async fn send(&self, message: M) -> Result<M::Result, MessageSendError> {
        Ok(self.0.send(message).await)
    }
}