Struct futures::task::RawWaker

[+] Show declaration

pub struct RawWaker { /* fields omitted */ }

[−] Expand description

A RawWaker allows the implementor of a task executor to create a Waker which provides customized wakeup behavior.

It consists of a data pointer and a virtual function pointer table (vtable) that customizes the behavior of the RawWaker.

Methods

impl RawWaker[−]

pub const fn new(data: *const (), vtable: &'static RawWakerVTable) -> RawWaker[+]

Creates a new RawWaker from the provided data pointer and vtable.

The data pointer can be used to store arbitrary data as required by the executor. This could be e.g. a type-erased pointer to an Arc that is associated with the task. The value of this poiner will get passed to all functions that are part of the vtable as the first parameter.

The vtable customizes the behavior of a Waker which gets created from a RawWaker. For each operation on the Waker, the associated function in the vtable of the underlying RawWaker will be called.

Trait Implementations

impl PartialEq<RawWaker> for RawWaker[+]

[+] Show hidden undocumented items

fn eq(&self, other: &RawWaker) -> bool[+]

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &RawWaker) -> bool[+]

This method tests for !=.

impl Debug for RawWaker[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>[+]

Formats the value using the given formatter.