# [−] [src] Struct mio::event::Events

    pub struct Events { /* fields omitted */ }

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.

# Examples

    use mio::{Events, Poll};
    use std::time::Duration;

    let mut events = Events::with_capacity(1024);
    let mut poll = Poll::new()?;

    // 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());
    }

## Implementations

### `impl Events` [src]

#### `pub fn with_capacity(capacity: usize) -> Events` [src]

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 capacity(&self) -> usize` [src]

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 is_empty(&self) -> bool` [src]

Returns `true` if `self` contains no `Event` values.

# Examples

    use mio::Events;

    let events = Events::with_capacity(1024);
    assert!(events.is_empty());

#### `pub fn iter(&self) -> Iter<'_>ⓘ

### Notable traits for Iter<'a>

`impl<'a> Iterator for Iter<'a> type Item = &'a Event;`
` [src]

Returns an iterator over the `Event` values.

# Examples

    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());
    }

#### `pub fn clear(&mut self)` [src]

Clearing all `Event` values from container explicitly.

# Notes

Events are cleared before every `poll`, so it is not required to call this manually.

# Examples

    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());

## Trait Implementations

### `impl Debug for Events` [src]

#### `fn fmt(&self, f: &mut Formatter<'_>) -> Result` [src]

Formats the value using the given formatter. Read more

### `impl<'a> IntoIterator for &'a Events` [src]

#### `type Item = &'a Event`

The type of the elements being iterated over.

#### `type IntoIter = Iter<'a>`

Which kind of iterator are we turning this into?

#### `fn into_iter(self) -> Self::IntoIter` [src]

Creates an iterator from a value. Read more

## Auto Trait Implementations

### `impl RefUnwindSafe for Events`

### `impl Send for Events`

### `impl Sync for Events`

### `impl Unpin for Events`

### `impl UnwindSafe for Events`

## Blanket Implementations

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `pub fn type_id(&self) -> TypeId` [src]

Gets the `TypeId` of `self`. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow(&self) -> &T` [src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow_mut(&mut self) -> &mut T` [src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T` [src]

#### `pub fn from(t: T) -> T` [src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `pub fn into(self) -> U` [src]

Performs the conversion.

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>` [src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

#### `type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

#### `pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>` [src]

Performs the conversion.