      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
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230

    use crate::event::Event;
    use crate::sys;

    use std::fmt;

    /// A collection of readiness events.
    ///
    /// `Events` is passed as an argument to [`Poll::poll`] and will be used to
    /// receive any new readiness events received since the last poll. Usually, a
    /// single `Events` instance is created at the same time as a [`Poll`] and
    /// reused on each call to [`Poll::poll`].
    ///
    /// See [`Poll`] for more documentation on polling.
    ///
    /// [`Poll::poll`]: ../struct.Poll.html#method.poll
    /// [`Poll`]: ../struct.Poll.html
    ///
    /// # Examples
    ///
    #[cfg_attr(feature = "os-poll", doc = "```")]
    #[cfg_attr(not(feature = "os-poll"), doc = "```ignore")]
    /// # use std::error::Error;
    /// # fn main() -> Result<(), Box<dyn Error>> {
    /// use mio::{Events, Poll};
    /// use std::time::Duration;
    ///
    /// let mut events = Events::with_capacity(1024);
    /// let mut poll = Poll::new()?;
    /// #
    /// # assert!(events.is_empty());
    ///
    /// // Register `event::Source`s with `poll`.
    ///
    /// poll.poll(&mut events, Some(Duration::from_millis(100)))?;
    ///
    /// for event in events.iter() {
    ///     println!("Got an event for {:?}", event.token());
    /// }
    /// #     Ok(())
    /// # }
    /// ```
    pub struct Events {
        inner: sys::Events,
    }

    /// [`Events`] iterator.
    ///
    /// This struct is created by the [`iter`] method on [`Events`].
    ///
    /// [`Events`]: struct.Events.html
    /// [`iter`]: struct.Events.html#method.iter
    ///
    /// # Examples
    ///
    #[cfg_attr(feature = "os-poll", doc = "```")]
    #[cfg_attr(not(feature = "os-poll"), doc = "```ignore")]
    /// # use std::error::Error;
    /// # fn main() -> Result<(), Box<dyn Error>> {
    /// use mio::{Events, Poll};
    /// use std::time::Duration;
    ///
    /// let mut events = Events::with_capacity(1024);
    /// let mut poll = Poll::new()?;
    ///
    /// // Register handles with `poll`.
    ///
    /// poll.poll(&mut events, Some(Duration::from_millis(100)))?;
    ///
    /// for event in events.iter() {
    ///     println!("Got an event for {:?}", event.token());
    /// }
    /// #     Ok(())
    /// # }
    /// ```
    #[derive(Debug, Clone)]
    pub struct Iter<'a> {
        inner: &'a Events,
        pos: usize,
    }

    impl Events {
        /// Return a new `Events` capable of holding up to `capacity` events.
        ///
        /// # Examples
        ///
        /// ```
        /// use mio::Events;
        ///
        /// let events = Events::with_capacity(1024);
        /// assert_eq!(1024, events.capacity());
        /// ```
        pub fn with_capacity(capacity: usize) -> Events {
            Events {
                inner: sys::Events::with_capacity(capacity),
            }
        }

        /// Returns the number of `Event` values that `self` can hold.
        ///
        /// ```
        /// use mio::Events;
        ///
        /// let events = Events::with_capacity(1024);
        /// assert_eq!(1024, events.capacity());
        /// ```
        pub fn capacity(&self) -> usize {
            self.inner.capacity()
        }

        /// Returns `true` if `self` contains no `Event` values.
        ///
        /// # Examples
        ///
        /// ```
        /// use mio::Events;
        ///
        /// let events = Events::with_capacity(1024);
        /// assert!(events.is_empty());
        /// ```
        pub fn is_empty(&self) -> bool {
            self.inner.is_empty()
        }

        /// Returns an iterator over the `Event` values.
        ///
        /// # Examples
        ///
        #[cfg_attr(feature = "os-poll", doc = "```")]
        #[cfg_attr(not(feature = "os-poll"), doc = "```ignore")]
        /// # use std::error::Error;
        /// # fn main() -> Result<(), Box<dyn Error>> {
        /// use mio::{Events, Poll};
        /// use std::time::Duration;
        ///
        /// let mut events = Events::with_capacity(1024);
        /// let mut poll = Poll::new()?;
        ///
        /// // Register handles with `poll`.
        ///
        /// poll.poll(&mut events, Some(Duration::from_millis(100)))?;
        ///
        /// for event in events.iter() {
        ///     println!("Got an event for {:?}", event.token());
        /// }
        /// #     Ok(())
        /// # }
        /// ```
        pub fn iter(&self) -> Iter<'_> {
            Iter {
                inner: self,
                pos: 0,
            }
        }

        /// Clearing all `Event` values from container explicitly.
        ///
        /// # Notes
        ///
        /// Events are cleared before every `poll`, so it is not required to call
        /// this manually.
        ///
        /// # Examples
        ///
        #[cfg_attr(feature = "os-poll", doc = "```")]
        #[cfg_attr(not(feature = "os-poll"), doc = "```ignore")]
        /// # use std::error::Error;
        /// # fn main() -> Result<(), Box<dyn Error>> {
        /// use mio::{Events, Poll};
        /// use std::time::Duration;
        ///
        /// let mut events = Events::with_capacity(1024);
        /// let mut poll = Poll::new()?;
        ///
        /// // Register handles with `poll`.
        ///
        /// poll.poll(&mut events, Some(Duration::from_millis(100)))?;
        ///
        /// // Clear all events.
        /// events.clear();
        /// assert!(events.is_empty());
        /// #     Ok(())
        /// # }
        /// ```
        pub fn clear(&mut self) {
            self.inner.clear();
        }

        /// Returns the inner `sys::Events`.
        pub(crate) fn sys(&mut self) -> &mut sys::Events {
            &mut self.inner
        }
    }

    impl<'a> IntoIterator for &'a Events {
        type Item = &'a Event;
        type IntoIter = Iter<'a>;

        fn into_iter(self) -> Self::IntoIter {
            self.iter()
        }
    }

    impl<'a> Iterator for Iter<'a> {
        type Item = &'a Event;

        fn next(&mut self) -> Option<Self::Item> {
            let ret = self
                .inner
                .inner
                .get(self.pos)
                .map(Event::from_sys_event_ref);
            self.pos += 1;
            ret
        }

        fn size_hint(&self) -> (usize, Option<usize>) {
            let size = self.inner.inner.len();
            (size, Some(size))
        }

        fn count(self) -> usize {
            self.inner.inner.len()
        }
    }

    impl fmt::Debug for Events {
        fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
            f.debug_list().entries(self).finish()
        }
    }