Trait ArcWake

pub trait ArcWake: Send + Sync {
    // Required method
    fn wake_by_ref(arc_self: &Arc<Self>);

    // Provided method
    fn wake(self: Arc<Self>) { ... }
}

A way of waking up a specific task.

By implementing this trait, types that are expected to be wrapped in an Arc can be converted into Waker objects. Those Wakers can be used to signal executors that a task it owns is ready to be polled again.

Currently, there are two ways to convert ArcWake into Waker:

• waker converts Arc<impl ArcWake> into Waker.
• waker_ref converts &Arc<impl ArcWake> into WakerRef that provides access to a &Waker.

Required Methods

fn wake_by_ref(arc_self: &Arc<Self>)

Indicates that the associated task is ready to make progress and should be polled.

This function can be called from an arbitrary thread, including threads which did not create the ArcWake based Waker.

Executors generally maintain a queue of “ready” tasks; wake_by_ref should place the associated task onto this queue.

This function is similar to wake, but must not consume the provided data pointer.

Provided Methods

fn wake(self: Arc<Self>)

Indicates that the associated task is ready to make progress and should be polled.

This function can be called from an arbitrary thread, including threads which did not create the ArcWake based Waker.

Executors generally maintain a queue of “ready” tasks; wake should place the associated task onto this queue.

Object Safety

This trait is not object safe.

Implementors