1.36.0[−][src]Struct futures::task::RawWakerVTable

[+] Show declaration

pub struct RawWakerVTable { /* fields omitted */ }

[−]

A virtual function pointer table (vtable) that specifies the behavior of a RawWaker.

The pointer passed to all functions inside the vtable is the data pointer from the enclosing RawWaker object.

The functions inside this struct are only intended be called on the data pointer of a properly constructed RawWaker object from inside the RawWaker implementation. Calling one of the contained functions using any other data pointer will cause undefined behavior.

Methods

`impl RawWakerVTable`[src][−]

`pub const fn new( clone: unsafe fn(const ()) -> RawWaker, wake: unsafe fn(const ()), wake_by_ref: unsafe fn(const ()), drop: unsafe fn(const ()) ) -> RawWakerVTable`[src][+]

Creates a new RawWakerVTable from the provided clone, wake, wake_by_ref, and drop functions.

`clone`

This function will be called when the RawWaker gets cloned, e.g. when the Waker in which the RawWaker is stored gets cloned.

The implementation of this function must retain all resources that are required for this additional instance of a RawWaker and associated task. Calling wake on the resulting RawWaker should result in a wakeup of the same task that would have been awoken by the original RawWaker.

`wake`

This function will be called when wake is called on the Waker. It must wake up the task associated with this RawWaker.

The implementation of this function must make sure to release any resources that are associated with this instance of a RawWaker and associated task.

`wake_by_ref`

This function will be called when wake_by_ref is called on the Waker. It must wake up the task associated with this RawWaker.

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

`drop`

This function gets called when a RawWaker gets dropped.

The implementation of this function must make sure to release any resources that are associated with this instance of a RawWaker and associated task.