impl<'fd> PollFd<'fd>

fn new(fd: BorrowedFd<'fd>, events: PollFlags) -> PollFd<'fd>

Creates a new PollFd specifying the events of interest for a given file descriptor.

Examples

# use std::os::unix::io::{AsFd, AsRawFd, FromRawFd};
# use nix::{
#     poll::{PollTimeout, PollFd, PollFlags, poll},
#     unistd::{pipe, read}
# };
let (r, w) = pipe().unwrap();
let pfd = PollFd::new(r.as_fd(), PollFlags::POLLIN);

These are placed in an array and passed to poll or ppoll.

fn revents(&self) -> Option<PollFlags>

Returns the events that occurred in the last call to poll or ppoll. Will only return None if the kernel provides status flags that Nix does not know about.

fn any(&self) -> Option<bool>

Returns if any of the events of interest occured in the last call to poll or ppoll. Will only return None if the kernel provides status flags that Nix does not know about.

Equivalent to x.revents()? != PollFlags::empty().

This is marginally more efficient than PollFd::all.

fn all(&self) -> Option<bool>

Returns if all the events of interest occured in the last call to poll or ppoll. Will only return None if the kernel provides status flags that Nix does not know about.

Equivalent to x.revents()? & x.events() == x.events().

This is marginally less efficient than PollFd::any.

fn events(&self) -> PollFlags

The events of interest for this PollFd.

fn set_events(&mut self, events: PollFlags)

Modify the events of interest for this PollFd.