mio-st 0.2.3

Single threaded, lightweight non-blocking IO
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

//! Readiness event types and utilities.

mod evented;
mod events;
mod id;
mod ready;

pub use self::evented::Evented;
pub use self::events::Events;
pub use self::id::EventedId;
pub use self::ready::Ready;

/// A readiness event.
///
/// `Event` is a [readiness state] paired with a [`EventedId`]. It is returned by
/// [`Poller.poll`].
///
/// For more documentation on polling and events, see [`Poller`].
///
/// # Examples
///
/// ```
/// use mio_st::event::{Event, EventedId, Ready};
///
/// let event = Event::new(EventedId(0), Ready::READABLE | Ready::WRITABLE);
///
/// assert_eq!(event.id(), EventedId(0));
/// assert_eq!(event.readiness(), Ready::READABLE | Ready::WRITABLE);
/// ```
///
/// [readiness state]: struct.Ready.html
/// [`EventedId`]: struct.EventedId.html
/// [`Poller.poll`]: ../poll/struct.Poller.html#method.poll
/// [`Poller`]: ../poll/struct.Poller.html
#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)]
pub struct Event {
    id: EventedId,
    readiness: Ready,
}

impl Event {
    /// Creates a new `Event` containing `id` and `readiness`.
    pub fn new(id: EventedId, readiness: Ready) -> Event {
        Event { id, readiness }
    }

    /// Returns the event's id.
    pub fn id(&self) -> EventedId {
        self.id
    }

    /// Returns the event's readiness.
    pub fn readiness(&self) -> Ready {
        self.readiness
    }
}

#[cfg(test)]
mod tests {
    use crate::event::{Event, EventedId, Ready};

    #[test]
    fn event() {
        let event = Event::new(EventedId(0), Ready::READABLE);
        assert_eq!(event.id(), EventedId(0));
        assert_eq!(event.readiness(), Ready::READABLE);
    }

    #[test]
    fn equality() {
        let event = Event::new(EventedId(0), Ready::WRITABLE);
        assert_eq!(event, event.clone());

        // Same
        let event2 = Event::new(EventedId(0), Ready::WRITABLE);
        assert_eq!(event, event2);

        // Different id.
        let event3 = Event::new(EventedId(1), Ready::WRITABLE);
        assert_ne!(event, event3);

        // Different readiness.
        let event4 = Event::new(EventedId(0), Ready::READABLE);
        assert_ne!(event, event4);
    }
}