Skip to main content

WakePipe

Struct WakePipe 

Source
pub struct WakePipe { /* private fields */ }
Expand description

Cross-platform wake notification built on pipe().

The write end signals, the read end is pollable via epoll/kqueue/poll.

Implementations§

Source§

impl WakePipe

Source

pub fn new() -> Self

Create a new wake pipe.

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

Source

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.

Source

pub fn drain(&self)

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

Source

pub fn as_raw_fd(&self) -> RawFd

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

Becomes readable when wake() has been called.

Trait Implementations§

Source§

impl Default for WakePipe

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.