basu 0.1.9

Eventbus crate with sync and async features
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
97

//! # A Tour of Basu
//!
//! Basu is a crate designed to enable event-driven architectures in Rust applications
//! with ease and flexibility.
//!
//! ### Features:
//!
//! - Support for both asynchronous and synchronous event handling. Choose the approach
//!   that best fits your application's needs.
//!
//! - Provides an abstraction for representing events, allowing you to define custom
//!   event structures with payload data.
//!
//! - Well-defined error types and error handling mechanisms for reliable event bus
//!   operations.
//!
//! To enable the synchronous event handling capability, use the `sync` feature:
//!
//! ```toml
//! [dependencies]
//! basu = { version = "0.1.0", default-features = false, features = ["sync"] }
//! ```
//!
//! To enable the asynchronous event handling capability, use the `async` feature:
//!
//! ```toml
//! [dependencies]
//! basu = "0.1.0"
//! ```
#![deny(missing_docs)]

#[cfg(not(any(feature = "async", feature = "sync")))]
compile_error!("Either `async` or `sync` feature must be enabled");

#[cfg(all(feature = "async", feature = "sync"))]
compile_error!("The `async` and `sync` features cannot be enabled simultaneously");

/// basu error
pub mod error;
/// basu event
pub mod event;
#[cfg(feature = "async")]
mod impl_async;
#[cfg(feature = "sync")]
mod impl_sync;
#[cfg(test)]
mod tests;

#[cfg(feature = "async")]
pub use async_trait::async_trait;
#[cfg(feature = "async")]
pub use impl_async::Handle;
#[cfg(feature = "sync")]
pub use impl_sync::Handle;
#[cfg(feature = "sync")]
use std::sync::Mutex;
#[cfg(feature = "async")]
use tokio::sync::Mutex;

use std::{collections::HashMap, sync::Arc};

use uuid::Uuid;

/// Handler
pub type Handler<T> = Box<dyn Handle<T>>;
/// Handler map with Id
pub type HandlerMap<T> = Arc<Mutex<HashMap<HandlerId, Handler<T>>>>;
/// Event Handler map
pub type EventHandlerMap<T> = Arc<Mutex<HashMap<String, HandlerMap<T>>>>;

/// An asynchronous `EventBus` to interact with.
#[derive(Default)]
pub struct EventBus<T> {
    event_handler_map: EventHandlerMap<T>,
}

impl<T> EventBus<T> {
    /// create a new `EventBus`
    pub fn new() -> Self {
        Self {
            event_handler_map: Default::default(),
        }
    }
}

/// HandlerId is the key in `HandlerMap` hash map.
#[derive(Eq, Hash, PartialEq, Clone, Debug, Default)]
pub struct HandlerId {
    id: Uuid,
}

impl HandlerId {
    /// create a new `HandlerId`
    pub fn new() -> Self {
        Self { id: Uuid::new_v4() }
    }
}