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
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

//! Channels which can be used by the `ChannelReporter` and `ChannelEventListener`.

use std::fmt::Formatter;
use std::{any, fmt};

// --- Event channel variants

/// A channel over which events are sent, from the `ChannelReporter` to the `ChannelEventListener`.
pub fn event_channel<Event>() -> (EventSender<Event>, EventReceiver<Event>) {
    let (sender, receiver) = crossbeam_channel::unbounded::<Event>();

    (EventSender(sender), EventReceiver(receiver))
}

/// A sender, used by `ChannelReporter` and `ChannelEventListener`.
#[derive(Clone)]
pub struct EventSender<T>(crossbeam_channel::Sender<T>);

impl<T> EventSender<T> {
    pub fn send(&self, message: T) -> Result<(), EventSendError<T>> {
        self.0.send(message).map_err(|err| EventSendError(err.0))
    }

    /// When all senders are disconnected, the channel is disconnected
    pub fn disconnect(self) {
        drop(self.0)
    }
}

/// A receiver, used by `ChannelReporter` and `ChannelEventListener`.
pub struct EventReceiver<T>(crossbeam_channel::Receiver<T>);

impl<T> EventReceiver<T> {
    pub fn recv(&self) -> Result<T, EventRecvError> {
        self.0.recv().map_err(|_| EventRecvError)
    }
}

impl<T> Clone for EventReceiver<T> {
    fn clone(&self) -> Self {
        Self(self.0.clone())
    }
}

#[derive(PartialEq, Eq, Clone, Copy)]
pub struct EventSendError<T>(pub T);

impl<T> fmt::Debug for EventSendError<T> {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        f.write_fmt(format_args!("EventSendError({})", any::type_name::<T>()))
    }
}

#[derive(Debug, PartialEq, Eq, Clone, Copy)]
pub struct EventRecvError;