Struct std::task::RawWakerVTable
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 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.
Implementations
impl RawWakerVTable
pub const fn new(
clone: unsafe fn(*const ()) -> RawWaker,
wake: unsafe fn(*const ()),
wake_by_ref: unsafe fn(*const ()),
drop: unsafe fn(*const ())
) -> RawWakerVTable
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.
Trait Implementations
impl Clone for RawWakerVTable
pub fn clone(&self) -> RawWakerVTable
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl Debug for RawWakerVTable
pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>
Formats the value using the given formatter. Read more
impl PartialEq<RawWakerVTable> for RawWakerVTable
pub fn eq(&self, other: &RawWakerVTable) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
pub fn ne(&self, other: &RawWakerVTable) -> bool
This method tests for !=
.
impl Copy for RawWakerVTable
impl StructuralPartialEq for RawWakerVTable
Auto Trait Implementations
impl RefUnwindSafe for RawWakerVTable
impl Send for RawWakerVTable
impl Sync for RawWakerVTable
impl Unpin for RawWakerVTable
impl UnwindSafe for RawWakerVTable
Blanket Implementations
impl<T> From<T> for T
pub fn from(t: T) -> T
Performs the conversion.
pub fn into(self) -> U
Performs the conversion.
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
#41263)recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
Performs the conversion.
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
Performs the conversion.
© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/task/struct.RawWakerVTable.html