Struct base::sys::linux::event::PlatformEvent

pub(crate) struct PlatformEvent {
    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 PlatformEvent

pub fn new() -> Result<PlatformEvent>

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

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

See EventExt::write_count.

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

See EventExt::read_count.

pub fn signal(&self) -> Result<()>

See Event::signal.

pub fn wait(&self) -> Result<()>

See Event::wait.

pub fn wait_timeout(&self, timeout: Duration) -> Result<EventWaitResult>

See Event::wait_timeout.

pub fn reset(&self) -> Result<()>

See Event::reset.

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

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 PlatformEvent

fn as_raw_descriptor(&self) -> RawDescriptor

Returns the underlying raw descriptor.

impl Debug for PlatformEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PlatformEvent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<PlatformEvent> for SafeDescriptor

fn from(evt: PlatformEvent) -> Self

Converts to this type from the input type.

impl From<SafeDescriptor> for PlatformEvent

fn from(sd: SafeDescriptor) -> Self

Converts to this type from the input type.

impl FromRawDescriptor for PlatformEvent

unsafe fn from_raw_descriptor(descriptor: RawDescriptor) -> Self

Safety

impl IntoRawDescriptor for PlatformEvent

fn into_raw_descriptor(self) -> RawDescriptor

impl PartialEq for PlatformEvent

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

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

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

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

impl Serialize for PlatformEvent

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 PlatformEvent

impl StructuralPartialEq for PlatformEvent