Struct futures_util::future::OptionFuture

source · [−]

pub struct OptionFuture<F> { /* private fields */ }

Expand description

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

source

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

source

fn clone(&self) -> OptionFuture<F>ⓘNotable traits for OptionFuture<F>`impl<F: Future> Future for OptionFuture<F> type Output = Option<F::Output>;`

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

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

source

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

Formats the value using the given formatter. Read more

source

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

source

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

Performs the conversion.

source

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

source

fn is_terminated(&self) -> bool

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

source

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

type Output = Option<F::Output>

The type of value produced on completion.

source

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. Read more

source

impl<'pin, F> Unpin for OptionFuture<F> where
Origin<'__pin, F>: Unpin,

Auto Trait Implementations

impl<F> RefUnwindSafe for OptionFuture<F> where
F: RefUnwindSafe,

impl<F> Send for OptionFuture<F> where
F: Send,

impl<F> Sync for OptionFuture<F> where
F: Sync,

impl<F> UnwindSafe for OptionFuture<F> where
F: UnwindSafe,

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<F> IntoFuture for F where
F: Future,

type Output = <F as Future>::Output

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

The output that the future will produce on completion.

type Future = F

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

Which kind of future are we turning this into?

source

pub fn into_future(self) -> <F as IntoFuture>::Future

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

Creates a future from a value.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

pub fn clone_into(&self, target: &mut T)

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

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct futures_util::future::OptionFuture

Examples

Trait Implementations

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

fn clone(&self) -> OptionFuture<F>ⓘNotable traits for OptionFuture<F>impl<F: Future> Future for OptionFuture<F> type Output = Option<F::Output>;

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

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

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

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

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

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

fn is_terminated(&self) -> bool

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

type Output = Option<F::Output>

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

impl<'__pin, F> Unpin for OptionFuture<F> where __Origin<'__pin, F>: Unpin,

Auto Trait Implementations

impl<F> RefUnwindSafe for OptionFuture<F> where F: RefUnwindSafe,

impl<F> Send for OptionFuture<F> where F: Send,

impl<F> Sync for OptionFuture<F> where F: Sync,

impl<F> UnwindSafe for OptionFuture<F> where F: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<F> IntoFuture for F where F: Future,

type Output = <F as Future>::Output

type Future = F

pub fn into_future(self) -> <F as IntoFuture>::Future

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

fn clone(&self) -> OptionFuture<F>ⓘNotable traits for OptionFuture<F>`impl<F: Future> Future for OptionFuture<F> type Output = Option<F::Output>;`

impl<'pin, F> Unpin for OptionFuture<F> where
Origin<'__pin, F>: Unpin,

impl<F> RefUnwindSafe for OptionFuture<F> where
F: RefUnwindSafe,

impl<F> Send for OptionFuture<F> where
F: Send,

impl<F> Sync for OptionFuture<F> where
F: Sync,

impl<F> UnwindSafe for OptionFuture<F> where
F: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<F> IntoFuture for F where
F: Future,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,