Struct mio::Events[][src]

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 poll = Poll::new()?;

assert_eq!(0, events.len());

// Register `Evented` handles with `poll`

poll.poll(&mut events, Some(Duration::from_millis(100)))?;

for event in &events {
    println!("event={:?}", event);
}

Methods

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

Returns the number of Event values that self can hold.

use mio::Events;

let events = Events::with_capacity(1024);

assert_eq!(1024, events.capacity());

Returns true if self contains no Event values.

Examples

use mio::Events;

let events = Events::with_capacity(1024);

assert!(events.is_empty());

Important traits for Iter<'a>

Returns an iterator over the Event values.

Examples

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

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

// Register handles with `poll`

poll.poll(&mut events, Some(Duration::from_millis(100)))?;

for event in events.iter() {
    println!("event={:?}", event);
}

Clearing all Event values from container explicitly.

Examples

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

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

// Register handles with `poll`
for _ in 0..2 {
    events.clear();
    poll.poll(&mut events, Some(Duration::from_millis(100)))?;

    for event in events.iter() {
        println!("event={:?}", event);
    }
}

Trait Implementations

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

The type of the elements being iterated over.

Which kind of iterator are we turning this into?

Creates an iterator from a value. Read more

impl IntoIterator for Events
[src]

The type of the elements being iterated over.

Which kind of iterator are we turning this into?

Creates an iterator from a value. Read more

impl Debug for Events
[src]

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl Send for Events

impl Sync for Events