orsomafo 0.3.1

Event dispatcher crate
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

//! # Orsomafofo
//! Orsomafofo is a event dispatcher
//!
//! Events are dispatchable across threads. Handlers are executed asynchronously
//!
//! ## Example
//! ```
//! # use async_trait::async_trait;
//! # use orsomafo::{Dispatchable, DispatchedEvent, EventDispatcherBuilder, EventHandler};
//! # use tokio::time::{sleep, Duration};
//!
//! #[derive(Clone, Debug,serde::Serialize, serde::Deserialize )] // Event must be cloneable
//! struct MyEvent;
//!
//! impl orsomafo::Dispatchable for MyEvent {} // MyEvent is now dispatchable
//!
//!  // create a handler
//!  #[derive(Default)]  // Event handler must implement default
//!  struct MyEventHandler;
//!    
//!  #[orsomafo::async_trait]
//!   impl orsomafo::EventHandler for MyEventHandler {
//!        // called when event from "MyEvent" is dispatched
//!        async fn handle(&self, dispatched: &DispatchedEvent)  {
//!           let event: MyEvent = dispatched.the_event().unwrap();  // Get the instance of "MyEvent"
//!           println!("handled my event: {:#?}",event);
//!        }
//!    }
//!
//!  #[tokio::main]
//!  async fn main() {
//!    MyEvent::subscribe::<MyEventHandler>().await;
//!
//!    let event = MyEvent;
//!    event.dispatch_event();
//!
//! }
//! ```
//!
//! ## Example (The long way)
//! ```
//! # use async_trait::async_trait;
//! # use orsomafo::{Dispatchable, DispatchedEvent, EventDispatcherBuilder, EventHandler};
//! # use tokio::time::{sleep, Duration};
//!
//! #[derive(Clone, Debug, serde::Serialize, serde::Deserialize)] // Event must be clonable
//! struct MyEvent;
//!
//! impl orsomafo::Dispatchable for MyEvent {} // MyEvent is now dispatchable
//!
//!  // create a handler
//!  #[derive(Default)]  // Event handler must implement default
//!  struct MyEventHandler;
//!    
//!  #[orsomafo::async_trait]
//!   impl orsomafo::EventHandler for MyEventHandler {
//!        // called when event from "MyEvent" is dispatched
//!        async fn handle(&self, dispatched: &DispatchedEvent)  {
//!           let event: MyEvent = dispatched.the_event().unwrap();  // Get the instance of "MyEvent"
//!           println!("handled my event: {:#?}",event);
//!        }
//!    }
//!
//!  #[tokio::main]
//!  async fn main() {
//!   _ =  EventDispatcherBuilder::new()
//!         .listen::<MyEvent, MyEventHandler>() // Register "MyEventHandler" for "MyEvent"
//!         .build().await;
//!
//!    let event = MyEvent;
//!    event.dispatch_event();
//!
//! }
//! ```
mod builder;
mod closure_handler_wrapper;
mod dispatched_event;
mod event;
mod event_dispatcher;
mod event_listener;

pub use async_trait::async_trait;
pub use serde;

pub use builder::EventDispatcherBuilder;
pub use dispatched_event::DispatchedEvent;
pub use event::*;
pub use event_dispatcher::event_dispatcher;
pub use event_dispatcher::EventDispatcher;
pub use event_listener::Subscriber;

///! A simple way to setup the dispatcher
///!
pub async fn setup() {
    EventDispatcherBuilder::new().build().await;
}