Struct ReadyFuture

pub struct ReadyFuture(/* private fields */);

A handle to a ready future data.

The struct can be created from ready UnsafeFuture only, and it doesn’t provide methods such as poll except ReadyFuture::consume. You can get the result from the ready FutureData through the consume method, then associated FutureData will be dropped and deallocated.

See UnsafeFuture documentation to see how this struct is used.

Implementations

impl ReadyFuture

pub unsafe fn new(future: UnsafeFuture) -> Self

Creates a new ReadyFuture from the given ready UnsafeFuture.

Panics

Panics if associated future data is not ready.

Safety

Undefined behavior if associated FutureData is not alive.

Examples

See UnsafeFuture documentation.

pub unsafe fn consume<Arg, CR>(self, arg: Arg) -> CR

Takes the result out of associated future data, then converts it by the consume function registered at UnsafeFuture::new, and then returns the converted result.

By taking self, it’s dropped at the end of the method, then drops and deallocates the associated future data as well.

Safety

Arg and CR must be the same as the types determined on UnsafeFuture::new.

Examples

See UnsafeFuture documentation.

Trait Implementations

impl Debug for ReadyFuture

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for ReadyFuture

fn drop(&mut self)

Executes the destructor for this type.