rs_events 0.1.0

A flexible and ergonomic event emission crate for Rust. Supports both std/threaded and no_std/alloc environments, with tagging, listener lifetimes, async/sync emission, and robust error handling.
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

#[cfg(not(feature = "threaded"))]
extern crate alloc;
#[cfg(not(feature = "threaded"))]
use alloc::sync::Arc;

#[cfg(feature = "threaded")]
use std::sync::Arc;

/// Type alias for an event payload pointer.
///
/// Uses `Arc<T>` for both threaded and embedded builds.
///
/// # Example
/// ```
/// #[cfg(not(feature = "threaded"))]
/// extern crate alloc;
/// #[cfg(not(feature = "threaded"))]
/// use alloc::sync::Arc;
///
/// #[cfg(feature="threaded")]
/// use std::sync::Arc;
///
/// use rs_events::{Callback, EventPayload};
/// let payload: EventPayload<String> = Arc::new(String::from("Emitting value"));
/// ```
pub type EventPayload<T> = Arc<T>;

/// Type alias for a callback pointer.
///
/// - Allows any closure (no thread-safety required).
///
/// # Example (embedded/no_std)
/// ```
/// extern crate alloc;
/// use alloc::sync::Arc;
/// use rs_events::{Callback, EventPayload};
/// let callback: Callback<String> = Arc::new(move |payload: &EventPayload<String>| {
///     println!("Received event: {}", payload);
/// });
/// ```
#[cfg(not(feature = "threaded"))]
pub type Callback<T> = Arc<dyn Fn(&EventPayload<T>)>;

/// Type alias for a callback pointer.
///
/// - Requires `Send + Sync` for thread safety.
///
/// # Example (threaded)
/// ```
/// use std::sync::Arc;
/// use rs_events::{Callback, EventPayload};
/// let callback: Callback<String> = Arc::new(move |payload: &EventPayload<String>| {
///     println!("Received event: {}", payload);
/// });
#[cfg(feature = "threaded")]
pub type Callback<T> = Arc<dyn Fn(&EventPayload<T>) + Send + Sync>;