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 155 156
use std::sync::mpsc::TryRecvError;
use async_std::sync::Mutex;
use async_trait::async_trait;
use std::fmt::Debug;
use super::*;
use crate::synchronous::basic::{BasicMediator, SyncMediatorInternal, SyncMediatorInternalNext};
/// Basic async mediator for asynchronous environments with events of type `Ev`.
///
/// A [`BasicAsyncMediator`] is constructed through its builder.
/// It receives requests through its [`AsyncMediatorInternalHandle::send()`]
/// interface, which are processed by the user-defined [`AsyncRequestHandler`] implementation.
/// From within this `async` handler, events of type `Ev` can be published using the
/// [`BasicAsyncMediator::publish()`] functionality.
/// Listeners injected with [`super::BasicAsyncBuilder::add_listener()`]
/// are invoked when the user calls [`BasicAsyncMediator::next()`].
///
/// # Examples
///
/// Basic usage:
///
/// ```
/// use mediator_sys::asynchronous::basic::*;
/// use async_trait::async_trait;
/// use async_std;
///
/// #[derive(Debug, Clone)]
/// enum MyEvent {
/// One,
/// Two
/// }
///
/// struct Request(u32);
///
/// #[async_trait]
/// impl AsyncRequestHandler<Request, MyEvent> for BasicAsyncMediator<MyEvent> {
/// async fn handle(&self, req: Request) {
/// match req.0 {
/// 1 => self.publish(MyEvent::One).await,
/// 2 => self.publish(MyEvent::Two).await,
/// _ => ()
/// };
/// }
/// }
///
/// async_std::task::block_on(async {
/// let mediator = BasicAsyncMediator::<MyEvent>::builder()
/// .add_listener(move |ev| {
/// /* Your listening logic */
/// })
/// .add_listener(move |ev| {
/// /* Your listening logic */
/// })
/// .build();
///
/// mediator.send(Request(1)).await;
/// mediator.next().await.ok();
/// });
///
#[cfg(feature = "async")]
#[derive(Debug)]
pub struct BasicAsyncMediator<Ev>
where
Ev: Debug,
{
pub(crate) basic: Mutex<BasicMediator<Ev>>,
}
#[async_trait]
impl<Ev> AsyncMediatorInternal<Ev> for BasicAsyncMediator<Ev>
where
Ev: Debug + Send,
{
/// Publishes an event `Ev` asynchronously.
///
/// This method locks the `Mutex` and instructs
/// the underlying [`BasicMediator`] to publish an event.
/// Best used within [`AsyncRequestHandler::handle()`].
///
/// You need to await the `Future` using `.await`.
///
/// # Examples
///
/// Basic usage:
///
/// ```
/// use mediator_sys::asynchronous::basic::*;
/// use async_trait::async_trait;
///
/// #[derive(Debug, Clone)]
/// enum MyEvent {
/// One,
/// Two
/// }
///
/// struct Request(u32);
///
/// #[async_trait]
/// impl AsyncRequestHandler<Request, MyEvent> for BasicAsyncMediator<MyEvent> {
/// async fn handle(&self, req: Request) {
/// match req.0 {
/// 1 => self.publish(MyEvent::One).await,
/// 2 => self.publish(MyEvent::Two).await,
/// _ => ()
/// };
/// }
/// }
///
async fn publish(&self, event: Ev) {
let m = self.basic.lock().await;
m.publish(event)
}
}
#[async_trait]
impl<Ev> AsyncMediatorInternalHandle<Ev> for BasicAsyncMediator<Ev>
where
Ev: Debug,
{
/// Send a request of type `Req` to the mediator asynchronously.
///
/// The request will be processed internally by [`AsyncRequestHandler::handle()`].
/// This is why it is required to implement [`AsyncRequestHandler`] for [`BasicAsyncMediator`].
///
/// You need to await the `Future` using `.await`.
///
async fn send<Req>(&self, req: Req)
where
Self: AsyncRequestHandler<Req, Ev>,
Req: Send,
{
<Self as AsyncRequestHandler<Req, Ev>>::handle(self, req).await
}
}
#[async_trait]
impl<Ev> AsyncMediatorInternalNext for BasicAsyncMediator<Ev>
where
Ev: Debug + Clone + Send,
{
/// Process the next published event `Ev` asynchronously.
///
/// This method locks the `Mutex` and instructs
/// the underlying [`BasicMediator`] to process the next event.
///
/// See [`BasicMediator::next()`] for more info.
///
/// You need to await the `Future` using `.await`.
///
async fn next(&self) -> Result<(), TryRecvError> {
let m = self.basic.lock().await;
m.next()
}
}