Struct WakePipe 

pub struct WakePipe { /* private fields */ }

Cross-platform wake notification.

On Unix, the write end signals and the read end is pollable via epoll/kqueue/poll. On Windows, wakeups are coalesced behind a manual-reset event for code that needs a blocking wait.

Implementations

impl WakePipe

pub fn new() -> WakePipe

Create a new wake pipe.

Both ends are set to non-blocking and close-on-exec.

pub fn wake(&self)

Signal the reader. Safe to call from any thread, multiple times.

Writes a single byte. If the pipe buffer is full the write is silently dropped — the reader will still wake because there are unread bytes.

pub fn drain(&self)

Drain all pending wake signals. Call after processing to reset the pipe for the next edge-triggered notification.

pub fn wait_timeout(&self, timeout: Duration) -> bool

Block until the wake primitive is signaled or the timeout expires.

Returns true if the primitive was signaled and false on timeout.

pub fn as_raw_fd(&self) -> i32

File descriptor for epoll/kqueue/poll(2) registration.

Becomes readable when wake() has been called.

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

Clone the pollable read end for an independently owned registration.

Trait Implementations

impl Default for WakePipe

fn default() -> WakePipe

Returns the “default value” for a type.