event-listener-primitives 0.2.2

Low-level primitive for building Node.js-like event listeners
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

## Event listener primitives

[![Build Status](https://img.shields.io/travis/com/nazar-pc/event-listener-primitives/master?style=flat-square)](https://travis-ci.com/nazar-pc/event-listener-primitives)
[![Crates.io](https://img.shields.io/crates/v/event-listener-primitives?style=flat-square)](https://crates.io/crates/event-listener-primitives)
[![Docs](https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square)](https://docs.rs/event-listener-primitives)
[![License](https://img.shields.io/github/license/nazar-pc/event-listener-primitives?style=flat-square)](https://github.com/nazar-pc/event-listener-primitives)

This crate provides a low-level primitive for building Node.js-like event listeners.

The 3 primitives are [`Bag`] that is a container for `Fn()` event handlers, [`BagOnce`] the same for `FnOnce()` event handlers and [`HandlerId`] that will remove event handler from the bag on drop.

Trivial example:
```rust
use event_listener_primitives::{Bag, HandlerId};

fn main() {
    let bag = Bag::default();

    let handler_id = bag.add(move || {
        println!("Hello")
    });

    bag.call_simple();
}
```

Close to real-world usage example:
```rust
use event_listener_primitives::{Bag, HandlerId};
fn main() {
    let bag = Bag::default();
    let handler_id = bag.add(Box::new(move || {
        println!("Hello")
    }));
    bag.call_simple();
}
```
Close to real-world usage example:
```rust
use event_listener_primitives::{Bag, BagOnce, HandlerId};
use std::sync::Arc;
#[derive(Default)]
struct Handlers {
    bar: Bag<Box<dyn Fn() + Send + Sync + 'static>>,
    closed: BagOnce<Box<dyn FnOnce() + Send + Sync + 'static>>,
}
struct Inner {
    handlers: Arc<Handlers>,
}
impl Drop for Inner {
    fn drop(&mut self) {
        self.handlers.closed.call_simple();
    }
}
#[derive(Clone)]
pub struct Foo {
    inner: Arc<Inner>,
}
impl Foo {
    pub fn new() -> Self {
        let handlers = Arc::<Handlers>::default();
        let inner = Arc::new(Inner { handlers });
        Self { inner }
    }
    pub fn do_bar(&self) {
        // Do things...
        self.inner.handlers.bar.call_simple();
    }
    pub fn do_other_bar(&self) {
        // Do things...
        self.inner.handlers.bar.call(|callback| {
            callback();
        });
    }
    pub fn on_bar<F: Fn() + Send + Sync + 'static>(&self, callback: F) -> HandlerId {
        self.inner.handlers.bar.add(Box::new(callback))
    }
    pub fn on_closed<F: FnOnce() + Send + Sync + 'static>(&self, callback: F) -> HandlerId {
        self.inner.handlers.closed.add(Box::new(callback))
    }
}
fn main() {
    let foo = Foo::new();
    let on_bar_handler_id = foo.on_bar(|| {
        println!("On bar");
    });
    foo
        .on_closed(|| {
            println!("On closed");
        })
        .detach();
    // This will trigger "bar" callback just fine since its handler ID is not dropped yet
    foo.do_bar();
    drop(on_bar_handler_id);
    // This will not trigger "bar" callback since its handler ID was already dropped
    foo.do_other_bar();
    // This will trigger "closed" callback though since we've detached handler ID
    drop(foo);
    println!("Done");
}
```

The output will be:
```text
On bar
On closed
Done
```

## Contribution
Feel free to create issues and send pull requests, they are highly appreciated!

## License
Zero-Clause BSD

https://opensource.org/licenses/0BSD

https://tldrlegal.com/license/bsd-0-clause-license