std::task::RawWakerVTable - Rust
Description: API documentation for the Rust `RawWakerVTable` struct in crate `std`.
Keywords: rust, rustlang, rust-lang, RawWakerVTable

# 1.36.0[−][src]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 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.

## Trait Implementations

### `impl PartialEq<RawWakerVTable> for RawWakerVTable`[src]

#### `fn eq(&self, other: &RawWakerVTable) -> bool`[src]

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

#### `fn ne(&self, other: &RawWakerVTable) -> bool`[src]

This method tests for `!=`.

### `impl Debug for RawWakerVTable`[src]

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

Formats the value using the given formatter. Read more

### `impl Clone for RawWakerVTable`[src]

#### `fn clone(&self) -> RawWakerVTable`[src]

Returns a copy of the value. Read more

#### `fn clone_from(&mut self, source: &Self)`1.0.0[src]

Performs copy-assignment from `source`. Read more

### `impl StructuralPartialEq for RawWakerVTable`[src]

### `impl Copy for RawWakerVTable`[src]

## Auto Trait Implementations

### `impl UnwindSafe for RawWakerVTable`

### `impl RefUnwindSafe for RawWakerVTable`

### `impl Unpin for RawWakerVTable`

### `impl Send for RawWakerVTable`

### `impl Sync for RawWakerVTable`

## Blanket Implementations

### `impl<T> From<T> for T`[src]

#### `fn from(t: T) -> T`[src]

Performs the conversion.

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `fn into(self) -> U`[src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

#### `type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

#### `fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

Performs the conversion.

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

####
ⓘImportant traits for &'_ mut I

### Important traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<'_, R: Read + ?Sized> Read for &'_ mut Rimpl<'_, W: Write + ?Sized> Write for &'_ mut W`
`fn borrow(&self) -> &T`[src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

####
ⓘImportant traits for &'_ mut I

### Important traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<'_, R: Read + ?Sized> Read for &'_ mut Rimpl<'_, W: Write + ?Sized> Write for &'_ mut W`
`fn borrow_mut(&mut self) -> &mut T`[src]

Mutably borrows from an owned value. Read more

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `fn type_id(&self) -> TypeId`[src]

Gets the `TypeId` of `self`. Read more

### `impl<T> ToOwned for T where
T: Clone,` [src]

#### `type Owned = T`

The resulting type after obtaining ownership.

#### `fn to_owned(&self) -> T`[src]

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

#### `fn clone_into(&self, target: &mut T)`[src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into` #41263)

recently added

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