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

use std::fmt;

/// Associates readiness notifications with [`Evented`] handles.
///
/// `EventedId` is used as an argument to [`Poller.register`] and
/// [`Poller.reregister`] and is used to associate an [`Event`] with an
/// [`Evented`] handle.
///
/// See [`Poller`] for more documentation on polling.
///
/// # Uniqueness of `EventedId`
///
/// `EventedId` does not have to be unique within a `Poller` instance, it is
/// purely a tool for the user of `Poller` to associate an `Event` with an
/// `Evented` handle. It is advised for example to use the same `EventedId` for
/// say a `TcpStream` and any related timeout or deadline for the same
/// connection. The `EventedID` is effectively opaque to `Poller`.
///
/// [`Evented`]: ../event/trait.Evented.html
/// [`Poller.register`]: ../poll/struct.Poller.html#method.register
/// [`Poller.reregister`]: ../poll/struct.Poller.html#method.reregister
/// [`Event`]: ../event/struct.Event.html
/// [`Poller`]: ../poll/struct.Poller.html
#[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
#[repr(transparent)]
pub struct EventedId(pub usize);

impl From<usize> for EventedId {
    fn from(val: usize) -> EventedId {
        EventedId(val)
    }
}

impl From<EventedId> for usize {
    fn from(val: EventedId) -> usize {
        val.0
    }
}

impl fmt::Display for EventedId {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        self.0.fmt(f)
    }
}

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

    #[test]
    fn event() {
        let id = EventedId(0);
        assert_eq!(EventedId::from(0), EventedId(0));
        assert_eq!(usize::from(id), 0);
        assert_eq!(id.0, 0);
        assert_eq!(id, id.clone());

        let max_value = usize::max_value();
        let id = EventedId(max_value);
        assert_eq!(EventedId::from(max_value), EventedId(max_value));
        assert_eq!(usize::from(id), max_value);
        assert_eq!(id.0, max_value);
        assert_eq!(id, id.clone());
    }
}