Docs4dev
Docs
rust / latest / std / task / struct.rawwaker.html

Struct std::task::RawWaker

pub struct RawWaker { /* private fields */ }

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.

Implementations

source 
impl RawWaker
const: 1.36.0source 
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 pointer 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.

source 
pub fn data(&self) -> *const ()
🔬This is a nightly-only experimental API. (waker_getters #87021)

Get the data pointer used to create this RawWaker.

source 
pub fn vtable(&self) -> &'static RawWakerVTable
🔬This is a nightly-only experimental API. (waker_getters #87021)

Get the vtable pointer used to create this RawWaker.

Trait Implementations

source 
impl Debug for RawWaker
source 
fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>
Formats the value using the given formatter. Read more
1.51.0source 
impl<W> From<Arc<W>> for RawWaker
where
    W: Wake + Send + Sync + 'static,
source 
fn from(waker: Arc<W>) -> RawWaker

Use a Wake-able type as a RawWaker.

No heap allocations or atomic operations are used for this conversion.

source 
impl PartialEq for RawWaker
source 
fn eq(&self, other: &RawWaker) -> bool
This method tests for self and other values to be equal, and is used by ==.
1.0.0source 
fn ne(&self, other: &Rhs) -> bool
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source 
impl StructuralPartialEq for RawWaker

Auto Trait Implementations

impl RefUnwindSafe for RawWaker
impl !Send for RawWaker
impl !Sync for RawWaker
impl Unpin for RawWaker
impl UnwindSafe for RawWaker

Blanket Implementations

source 
impl<T> Any for T
where
    T: 'static + ?Sized,
source 
fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
source 
impl<T> Borrow<T> for T
where
    T: ?Sized,
source 
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
source 
impl<T> BorrowMut<T> for T
where
    T: ?Sized,
source 
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source 
impl<T> From<T> for T
source 
fn from(t: T) -> T

Returns the argument unchanged.

source 
impl<T, U> Into<U> for T
where
    U: From<T>,
source 
fn into(self) -> U

Calls U::from(self).

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

source 
impl<T, U> TryFrom<U> for T
where
    U: Into<T>,
 
type Error = Infallible
The type returned in the event of a conversion error.
source 
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
Performs the conversion.
source 
impl<T, U> TryInto<U> for T
where
    U: TryFrom<T>,
 
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
source 
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.RawWaker.html