Struct EventConsumer

pub struct EventConsumer { /* private fields */ }

Available on Unix only.

EventConsumer This is a generic event consumer that can be used with eventfd or pipefd. It allows reading a value from the file descriptor to consume an event.

Examples

use std::os::fd::FromRawFd;
use std::os::unix::io::IntoRawFd;
use vmm_sys_util::event::EventConsumer;
let (reader, _) = std::io::pipe().expect("Failed to create pipe");
let consumer = unsafe { EventConsumer::from_raw_fd(reader.into_raw_fd()) };

Implementations

impl EventConsumer

pub fn consume(&self) -> Result<(), Error>

Read a value from the EventConsumer.

pub fn try_clone(&self) -> Result<EventConsumer, Error>

Clone this EventConsumer.

Trait Implementations

impl AsRawFd for EventConsumer

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for EventConsumer

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

Formats the value using the given formatter.

impl FromRawFd for EventConsumer

unsafe fn from_raw_fd(fd: RawFd) -> Self

Constructs a new instance of Self from the given raw file descriptor.

impl IntoRawFd for EventConsumer

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.