Struct RingEventFd 

pub struct RingEventFd { /* private fields */ }

Process-local fd readiness bridge for one shared Orbit ring.

The established name is retained on macOS, where a nonblocking pipe backs the fd. Native macOS readiness requires 14.4 or later; older systems return ErrorKind::Unsupported from construction so callers can use polling.

Every subscribing process creates its own instance. Ring publishers bump a generation stored in SHM and wake all platform waiters; the local driver then marks this fd readable. Multiple publishes may coalesce into one wake, so a consumer must drain the fd and poll the ring through its own cursor.

Implementations

impl RingEventFd

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

Drain coalesced readiness tokens from the nonblocking local fd.

Ring events themselves remain in SHM; the returned number is only the local wake count and must not be interpreted as an event count.

Trait Implementations

impl AsFd for RingEventFd

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor.

impl AsRawFd for RingEventFd

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for RingEventFd

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

Formats the value using the given formatter.

impl Drop for RingEventFd

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.