Skip to main content

WakePipe

Struct WakePipe 

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

Wake notification built on pipe(2).

The pattern is:

  • one thread blocks on the read end with poll(2)
  • another thread writes one byte to the write end to signal “work exists”
  • the waiter drains pending bytes before going back to sleep

Why use a pipe here:

  • it gives us a real file descriptor that integrates with poll(2)
  • it works on the Unix platforms smolvm targets
  • it is simpler than building a custom condvar + timeout scheme around the smoltcp loop and Unix-stream writer

Implementations§

Source§

impl WakePipe

Source

pub fn new() -> Self

Create a non-blocking wake pipe.

Low-level steps:

pipe()               -> create read/write fds
fcntl(F_SETFL)       -> add O_NONBLOCK
fcntl(F_SETFD)       -> add FD_CLOEXEC
wrap in OwnedFd      -> move fd lifetime into Rust ownership
Source

pub fn wake(&self)

Signal the waiting side.

Writing one byte is enough. The byte value itself does not matter; only readability of the pipe matters. Multiple writes coalesce naturally into “there is pending wake state”.

Source

pub fn drain(&self)

Drain all pending wake bytes.

This resets the readiness state after a wake. Because the pipe is non-blocking, read <= 0 means “nothing more to drain right now”.

Source

pub fn wait(&self, timeout: Option<Duration>) -> Result<bool>

Wait until the pipe is readable or the timeout elapses.

This is the low-level equivalent of “sleep until another thread signals me or the timeout expires”, but implemented in file-descriptor space so it composes with other polling logic.

Source

pub fn as_raw_fd(&self) -> RawFd

File descriptor for poll(2).

Callers should treat this as a borrowed readiness handle, not as an fd they own or may close.

Trait Implementations§

Source§

impl Clone for WakePipe

Source§

fn clone(&self) -> Self

Clone by duplicating both file descriptors.

Each clone refers to the same underlying pipe objects, so waking or draining from any clone affects the shared readiness state.

1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for WakePipe

Source§

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

Formats the value using the given formatter. Read more
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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more