compio-actor 0.1.0

Actors for Compio
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

//! Actor definitions, lifecycle results, and handles.

mod deliver;
mod handle;

pub(crate) use deliver::{Delivering, finish, run};
#[doc(inline)]
pub use handle::{ActorExit, ActorHandle, ActorHandleError};

use crate::Mailbox;

/// A message that can cross into an actor cluster.
pub trait Message: Send + 'static {}

impl<T: Send + 'static> Message for T {}

/// A single-threaded actor with serial access to its state.
#[allow(async_fn_in_trait)]
pub trait Actor: Sized + 'static {
    /// State owned by the actor task.
    type State: 'static;
    /// Values moved to the worker to initialize the actor.
    type Arguments: Send + 'static;
    /// Errors reported across the cluster.
    type Error: Send + 'static;

    /// Initializes state on the actor's worker.
    async fn pre_start(
        &self,
        myself: &Mailbox<Self>,
        arguments: Self::Arguments,
    ) -> Result<Self::State, Self::Error>;

    /// Runs inside the actor task before it receives messages.
    async fn post_start(
        &self,
        _myself: &Mailbox<Self>,
        _state: &mut Self::State,
    ) -> Result<(), Self::Error> {
        Ok(())
    }

    /// Runs after message processing ends but before the mailbox is dropped.
    async fn pre_stop(
        &self,
        _myself: &Mailbox<Self>,
        _state: &mut Self::State,
    ) -> Result<(), Self::Error> {
        Ok(())
    }

    /// Runs after the mailbox has closed.
    async fn post_stop(
        &self,
        _myself: &Mailbox<Self>,
        _state: &mut Self::State,
    ) -> Result<(), Self::Error> {
        Ok(())
    }
}

/// Handles messages of type `M` for an actor.
#[allow(async_fn_in_trait)]
pub trait Handler<M: Message>: Actor {
    /// Handles one message at a time.
    async fn handle(
        &self,
        myself: &Mailbox<Self>,
        message: M,
        state: &mut Self::State,
    ) -> Result<(), Self::Error>;
}