nexosim 1.0.0

A high performance asynchronous compute framework for system simulation.
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

use std::fmt;

use futures_core::stream::Stream;

pub(crate) mod event_queue;
pub(crate) mod event_slot;

/// A writer handle to an event sink.
pub trait EventSinkWriter<T>: Clone + Send + Sync + 'static {
    /// Writes a value to the associated sink.
    fn write(&self, event: T);
}

/// An iterator over collected events with the ability to pause and resume event
/// collection. Accessing the next event can be blocking or non-blocking.
pub trait EventSinkReader<T>: Stream<Item = T> + Unpin {
    /// Starts or resumes the collection of new events.
    fn enable(&mut self);

    /// Pauses the collection of new events.
    ///
    /// Events that were collected in the queue prior to this call remain
    /// available.
    fn disable(&mut self);

    /// Returns the next event, if any.
    fn try_read(&mut self) -> Option<T>;

    /// Returns the next event, blocking the thread until the event becomes
    /// available if necessary.
    ///
    /// Returns `None` if all writers were dropped and there is no more event to
    /// be read.
    fn read(&mut self) -> Option<T>;
}

/// The state of a sink.
#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
pub enum SinkState {
    /// The sink accepts new events.
    Enabled,
    /// The sink ignores new events.
    Disabled,
}

impl fmt::Display for SinkState {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            SinkState::Enabled => write!(f, "enabled"),
            SinkState::Disabled => write!(f, "disabled"),
        }
    }
}