Struct futures_util::future::OptionFuture

#[must_use = "futures do nothing unless you `.await` or poll them"]pub struct OptionFuture<F>(_);

A future representing a value which may or may not be present.

Created by the From implementation for Option.

Examples

use futures::future::OptionFuture;

let mut a: OptionFuture<_> = Some(async { 123 }).into();
assert_eq!(a.await, Some(123));

a = None.into();
assert_eq!(a.await, None);

Trait Implementations

impl<F: Clone> Clone for OptionFuture<F>

pub fn clone(&self) -> OptionFuture<F>

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<F: Debug> Debug for OptionFuture<F>

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

Formats the value using the given formatter.

impl<T> From<Option<T>> for OptionFuture<T>

pub fn from(option: Option<T>) -> Self

Performs the conversion.

impl<F: FusedFuture> FusedFuture for OptionFuture<F>

pub fn is_terminated(&self) -> bool

Returns true if the underlying future should no longer be polled.

impl<F: Future> Future for OptionFuture<F>

type Output = Option<F::Output>

The type of value produced on completion.

pub 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<'pin, F> Unpin for OptionFuture<F> where
    __OptionFuture<'pin, F>: Unpin,