Struct std::task::RawWakerVTable

1.36.0 · source · []
pub struct RawWakerVTable { /* private fields */ }
Expand description

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 to 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.

These functions must all be thread-safe (even though RawWaker is !Send + !Sync) because Waker is Send + Sync, and thus wakers may be moved to arbitrary threads or invoked by & reference. For example, this means that if the clone and drop functions manage a reference count, they must do so atomically.

Implementations

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

These functions must all be thread-safe (even though RawWaker is !Send + !Sync) because Waker is Send + Sync, and thus wakers may be moved to arbitrary threads or invoked by & reference. For example, this means that if the clone and drop functions manage a reference count, they must do so atomically.

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.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

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

The resulting type after obtaining ownership.

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

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.