myriam 0.3.1

Actor model implementation for local and remote actors.
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

//!
//! abstractions for network layers and implementations
//!

use std::future::Future;

use tokio::io::{AsyncReadExt, AsyncWriteExt};

#[cfg(feature = "tcp")]
pub mod tcp_layer;

#[cfg(feature = "tor")]
pub mod tor_layer;

///
/// trait for AsyncRead + AsyncWrite streams used in routers
///
pub trait AsyncMsgStream: AsyncReadExt + AsyncWriteExt + Unpin + Send + 'static {}

impl<T> AsyncMsgStream for T where T: AsyncReadExt + AsyncWriteExt + Unpin + Send + 'static {}

///
/// net layer trait abstracting over async streams
///
pub trait NetLayer {
    /// errors during net layer operation
    type Error;

    ///
    /// net layer's identifier, using during actor address construction
    ///
    fn name() -> &'static str;

    ///
    /// connect to the given address, returning a stream
    ///
    fn connect(
        &self,
        addr: &str,
    ) -> impl Future<Output = Result<impl AsyncMsgStream, Self::Error>> + Send;

    ///
    /// initialize this net layer for accepting connections
    ///
    fn init(&mut self) -> impl Future<Output = Result<(), Self::Error>> + Send;

    ///
    /// wait for and accept the next connection
    ///
    fn accept(&self) -> impl Future<Output = Result<impl AsyncMsgStream, Self::Error>> + Send;

    ///
    /// this net layer's exposed address
    ///
    fn address(&self) -> impl Future<Output = Result<String, Self::Error>>;
}