Struct futures_util::future::OptionFuture

[+] Show declaration

[+] Expand attributes
#[must_use = "futures do nothing unless polled"]
pub struct OptionFuture<F> { /* fields omitted */ }

[−] Expand description

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

Created by the From implementation for Option.

Examples

#![feature(async_await, await_macro, futures_api)]
use futures::future::{self, OptionFuture};

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

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

Trait Implementations

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

[+]

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

[−]

Formats the value using the given formatter.

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

[+]

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

[−]

Returns a copy of the value.

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

[−]

Performs copy-assignment from source.

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

[+]

type Output = Option<F::Output>

🔬 This is a nightly-only experimental API. (futures_api)

futures in libcore are unstable

The result of the Future.

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

[−]

🔬 This is a nightly-only experimental API. (futures_api)

futures in libcore are unstable

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

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

[+]

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

[−]

Performs the conversion.