Struct this_state::StateFuture

pub struct StateFuture<S, C> { /* private fields */ }

A future that completes when the state matches the given predicate. This is returned by State::wait_for.

Notes

Unlike most futures, this future can be polled multiple times, even after it has completed.

Implementations

impl<S, C> StateFuture<S, C>

pub fn state(&self) -> &State<S>

Returns a reference to the current state.

This may be useful to create other futures or simply getting the current state.

Trait Implementations

impl<S, C> Drop for StateFuture<S, C>

fn drop(&mut self)

Executes the destructor for this type.

impl<S, C> Future for StateFuture<S, C>where C: Fn(&S) -> bool,

type Output = ()

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.

impl<S, C> Send for StateFuture<S, C>

impl<S, C> Sync for StateFuture<S, C>