Struct future_clicker::ControlledFuture

pub struct ControlledFuture<T: Unpin> { /* private fields */ }

A Future that will resolve either immediately, or in the future.

Will not resolve unless it has been explicitly completed, either by constructing it with ControlledFuture::new_completed, or using FutureClicker::complete.

Implementations

impl<T: Unpin + Send + 'static> ControlledFuture<T>

pub fn new() -> (Self, FutureClicker<T>)

Construct a ControlledFuture that will resolve once the returned FutureClicker is used to set a value.

pub fn new_completed(value: T) -> Self

Construct a ControlledFuture that will resolve immediately to the given value.

No FutureClicker is returned as the ControlledFuture is already complete.

Trait Implementations

impl<T: Debug + Unpin> Debug for ControlledFuture<T>

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

Formats the value using the given formatter.

impl<T: Unpin + 'static + Send> Future for ControlledFuture<T>

type Output = Result<T, Error>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.