storyteller 0.7.0

Library focused on supporting user oriented output while supporting multiple output types (e.g. json, a progressbar, etc.)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

/// This can be anything, for example a progress bar, a fake reporter which collects events
/// for testing, a service which sends the events over HTTP, or maybe even a `MultiHandler` which
/// consists of a `Vec<Box<dyn EventHandler>>` and executes multiple handlers under the hood.
pub trait EventHandler: Send + Sync {
    /// The type of event to be handled.
    /// Usually the same type as you would send from a [`EventReporter`] to [`EventListener`].
    ///
    /// [`EventReporter`]: crate::EventReporter
    /// [`EventListener`]: crate::EventListener
    type Event;

    /// Act upon some received event.
    fn handle(&self, event: Self::Event);

    /// A final action which can be performed when no more events will be received, for example
    /// when the message channel will be disconnected.
    ///
    /// It is up to the [`EventListener`] to call this method.
    ///
    /// [`EventListener`]: crate::EventListener
    fn finish(&self) {}
}