sitrep 0.4.0

Frontend-agnostic progress reporting
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

use std::sync::mpsc::Sender;

use crate::{Event, Observer};

/// Implementation of `Observer` based on `std::sync::mpsc::Sender`.
#[derive(Clone, Debug)]
pub struct StdMpscObserver {
    /// The sending-half of std's channel type.
    pub sender: Sender<Event>,
}

impl From<Sender<Event>> for StdMpscObserver {
    fn from(sender: Sender<Event>) -> Self {
        Self { sender }
    }
}

impl From<StdMpscObserver> for Sender<Event> {
    fn from(observer: StdMpscObserver) -> Self {
        observer.sender
    }
}

impl Observer for StdMpscObserver {
    fn observe(&self, event: Event) {
        #[cfg(feature = "tracing")]
        if let Err(err) = self.sender.send(event) {
            tracing::debug!(
                error = ?err,
                "Failed to send event: receiver has been dropped. This is expected during shutdown."
            );
        }

        #[cfg(not(feature = "tracing"))]
        let _ = self.sender.send(event);
    }
}

/// Implementation of `Observer` that does nothing.
#[derive(Clone, Debug)]
pub struct NopObserver;

impl Observer for NopObserver {
    fn observe(&self, event: Event) {
        let _ = event;
    }
}