Struct Events

pub struct Events { /* private fields */ }

Wrapper over an epoll::EpollEvent object.

When working directly with epoll related methods, the user associates an u64 wide epoll_data_t object with every event. We want to use fds as identifiers, but at the same time keep the ability to associate opaque data with an event. An Events object always contains an fd and an u32 data member that can be supplied by the user. When registering events with the inner epoll event set, the fd and data members of Events are used together to generate the underlying u64 member of the epoll_data union.

Implementations

impl Events

pub fn empty<T: AsRawFd>(source: &T) -> Self

Create an empty event set associated with source.

No explicit events are monitored for the associated file descriptor. Nevertheless, EventSet::ERROR and EventSet::HANG_UP are implicitly monitored.

Arguments

• source: object that wraps a file descriptor to be associated with events

Example

let eventfd = EventFd::new(0).unwrap();
let ev_set = Events::empty(&eventfd);

pub fn empty_raw(fd: RawFd) -> Self

Create an empty event set associated with the supplied RawFd value.

No explicit events are monitored for the associated file descriptor. Nevertheless, EventSet::ERROR and EventSet::HANG_UP are implicitly monitored.

Example

let eventfd = EventFd::new(0).unwrap();
let ev_set = Events::empty_raw(eventfd.as_raw_fd());

pub fn new<T: AsRawFd>(source: &T, events: EventSet) -> Self

Create an event with source and the associated events for monitoring.

Arguments

• source: object that wraps a file descriptor to be associated with events
• events: events to monitor on the provided source; EventSet::ERROR and EventSet::HANG_UP are always monitored and don’t need to be explicitly added to the list.

Example

let eventfd = EventFd::new(0).unwrap();
let event_set = EventSet::IN;
let ev_set = Events::new(&eventfd, event_set);

pub fn new_raw(source: RawFd, events: EventSet) -> Self

Create an event with the supplied RawFd value and events for monitoring.

Arguments

• source: file descriptor on which to monitor the events
• events: events to monitor on the provided source; EventSet::ERROR and EventSet::HANG_UP are always monitored and don’t need to be explicitly added to the list.

Example

let eventfd = EventFd::new(0).unwrap();
let event_set = EventSet::IN;
let ev_set = Events::new_raw(eventfd.as_raw_fd(), event_set);

pub fn with_data<T: AsRawFd>(source: &T, data: u32, events: EventSet) -> Self

Create an event set associated with the underlying file descriptor of the source, active events, and data.

Arguments

• source: object that wraps a file descriptor to be associated with events
• data: custom user data associated with the file descriptor; the data can be used for uniquely identify monitored events instead of using the file descriptor.
• events: events to monitor on the provided source; EventSet::ERROR and EventSet::HANG_UP are always monitored and don’t need to be explicitly added to the list.

Examples

let eventfd = EventFd::new(0).unwrap();
let event_set = EventSet::IN;
let custom_data = 42;
let ev_set = Events::with_data(&eventfd, custom_data, event_set);

pub fn with_data_raw(source: RawFd, data: u32, events: EventSet) -> Self

Create an event set associated with the supplied RawFd value, active events, and data.

Arguments

• source: file descriptor to be associated with events
• data: custom user data associated with the file descriptor; the data can be used for uniquely identify monitored events instead of using the file descriptor.
• events: events to monitor on the provided source; EventSet::ERROR and EventSet::HANG_UP are always monitored and don’t need to be explicitly added to the list.

Examples

let eventfd = EventFd::new(0).unwrap();
let event_set = EventSet::IN;
let custom_data = 42;
let ev_set = Events::with_data_raw(eventfd.as_raw_fd(), custom_data, event_set);

pub fn fd(&self) -> RawFd

Return the inner fd value.

pub fn data(&self) -> u32

Return the inner data value.

pub fn event_set(&self) -> EventSet

Return the active event set.

pub fn epoll_event(&self) -> EpollEvent

Return the inner EpollEvent.

Trait Implementations

impl Clone for Events

fn clone(&self) -> Events

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Events

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Events

fn eq(&self, other: &Events) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Events