Struct futures::Complete

pub struct Complete<T> { /* fields omitted */ }

Represents the completion half of a oneshot through which the result of a computation is signaled.

This is created by the oneshot function.

Methods

impl<T> Complete<T>

fn complete(self, t: T)

Completes this oneshot with a successful result.

This function will consume self and indicate to the other end, the Oneshot, that the error provided is the result of the computation this represents.

fn poll_cancel(&mut self) -> Poll<(), ()>

Polls this Complete half to detect whether the Oneshot this has paired with has gone away.

This function can be used to learn about when the Oneshot (consumer) half has gone away and nothing will be able to receive a message sent from complete.

Like Future::poll, this function will panic if it's not called from within the context of a task. In otherwords, this should only ever be called from inside another future.

If Ready is returned then it means that the Oneshot has disappeared and the result this Complete would otherwise produce should no longer be produced.

If NotReady is returned then the Oneshot is still alive and may be able to receive a message if sent. The current task, however, is scheduled to receive a notification if the corresponding Oneshot goes away.

Trait Implementations

impl<T> Drop for Complete<T>

fn drop(&mut self)

A method called when the value goes out of scope.