mediatrix 1.0.0

Strongly typed, extensible event mediator
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

use std::{fmt::Debug, sync::mpsc::TryRecvError};

use crate::mediator::listener::Listener;

/// Publish an event `Ev` from within a handler.
pub trait SyncMediatorInternal<Ev: Debug> {
    #[allow(missing_docs)]
    fn publish(&self, event: Ev);
}

/// Send a request `Req` for processing to the mediator.
/// This will call the handler.
pub trait SyncMediatorInternalHandle<Ev: Debug> {
    #[allow(missing_docs)]
    fn send<Req>(&self, req: Req)
    where
        Self: RequestHandler<Req, Ev>;
}

/// Process the next event `Ev` from the channel.
/// This will call all listeners with a clone of that event.
pub trait SyncMediatorInternalNext {
    #[allow(missing_docs)]
    fn next(&self) -> Result<(), TryRecvError>;
}

/// Handles the request `Req`.
/// Implemented by the user.
pub trait RequestHandler<Req, Res> {
    #[allow(missing_docs)]
    fn handle(&self, req: Req);
}

/// Basic builder fuctionality:
/// Adding a [`Listener`] to the builder.
pub trait BasicMediatorBuilderInterface<M, Ev> {
    #[allow(missing_docs)]
    fn add_listener(self, f: impl Listener<Ev>) -> Self
    where
        Ev: Debug;
}