Struct base::sys::unix::eventfd::EventFd

pub(crate) struct EventFd {
    event_handle: SafeDescriptor,
}

A safe wrapper around a Linux eventfd (man 2 eventfd).

An eventfd is useful because it is sendable across processes and can be used for signaling in and out of the KVM API. They can also be polled like any other file descriptor.

Fields

event_handle: SafeDescriptor

Implementations

impl EventFd

pub fn new() -> Result<EventFd>

Creates a new blocking EventFd with an initial value of 0.

pub fn write(&self, v: u64) -> Result<()>

Adds v to the eventfd’s count, blocking until this won’t overflow the count.

pub fn read(&self) -> Result<u64>

Blocks until the the eventfd’s count is non-zero, then resets the count to zero.

pub fn read_timeout(&self, timeout: Duration) -> Result<EventReadResult>

Blocks for a maximum of timeout duration until the the eventfd’s count is non-zero. If a timeout does not occur then the count is returned as a EventReadResult::Count(count), and the count is reset to 0. If a timeout does occur then this function will return EventReadResult::Timeout.

pub fn try_clone(&self) -> Result<EventFd>

Clones this EventFd, internally creating a new file descriptor. The new EventFd will share the same underlying count within the kernel.

Trait Implementations

impl AsRawDescriptor for EventFd

fn as_raw_descriptor(&self) -> RawDescriptor

Returns the underlying raw descriptor.

impl AsRawFd for EventFd

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for EventFd

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EventFd

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl From<EventFd> for SafeDescriptor

fn from(evt: EventFd) -> Self

Converts to this type from the input type.

impl FromRawDescriptor for EventFd

unsafe fn from_raw_descriptor(descriptor: RawDescriptor) -> Self

Safety

impl IntoRawDescriptor for EventFd

fn into_raw_descriptor(self) -> RawDescriptor

impl PartialEq<EventFd> for EventFd

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for EventFd

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Eq for EventFd

impl StructuralEq for EventFd

impl StructuralPartialEq for EventFd