Struct mio::event::Events [−][src]
pub struct Events { /* fields omitted */ }
Expand description
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
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());
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()); }
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
Auto Trait Implementations
impl RefUnwindSafe for Events
impl UnwindSafe for Events