[−][src]Struct futures_util::future::OptionFuture

#[must_use = "futures do nothing unless you `.await` or poll them"]
pub struct OptionFuture<F> { /* fields omitted */ }

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>`[src]

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

`fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl<T> From<Option<T>> for OptionFuture<T>`[src]

`fn from(option: Option<T>) -> Self`[src]

`impl<F: Debug> Debug for OptionFuture<F>`[src]

`fn fmt(&self, f: &mut Formatter) -> Result`[src]

`impl<F: Future> Future for OptionFuture<F>`[src]

`type Output = Option<F::Output>`

The type of value produced on completion.

`fn poll(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Self::Output>`[src]

`impl<F: FusedFuture> FusedFuture for OptionFuture<F>`[src]

`fn is_terminated(&self) -> bool`[src]

Auto Trait Implementations

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

`impl<F> Unpin for OptionFuture<F> where F: Unpin,`

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

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

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

Blanket Implementations

`impl<T> FutureExt for T where T: Future + ?Sized,` [src]

ⓘImportant traits for Map<Fut, F>
Important traits for Map<Fut, F>
`impl<Fut, F, T> Future for Map<Fut, F> where Fut: Future, F: FnOnce(Fut::Output) -> T, type Output = T;`
`fn map<U, F>(self, f: F) -> Map<Self, F> where F: FnOnce(Self::Output) -> U, Self: Sized,` [src]

ⓘImportant traits for Then<Fut1, Fut2, F>
Important traits for Then<Fut1, Fut2, F>
`impl<Fut1, Fut2, F> Future for Then<Fut1, Fut2, F> where Fut1: Future, Fut2: Future, F: FnOnce(Fut1::Output) -> Fut2, type Output = Fut2::Output;`
`fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where F: FnOnce(Self::Output) -> Fut, Fut: Future, Self: Sized,` [src]

ⓘImportant traits for Either<A, B>
Important traits for Either<A, B>
`impl<A, B> Future for Either<A, B> where A: Future, B: Future<Output = A::Output>, type Output = A::Output;`
`fn left_future(self) -> Either<Self, B> where B: Future<Output = Self::Output>, Self: Sized,` [src]

ⓘImportant traits for Either<A, B>
Important traits for Either<A, B>
`impl<A, B> Future for Either<A, B> where A: Future, B: Future<Output = A::Output>, type Output = A::Output;`
`fn right_future<A>(self) -> Either<A, Self> where A: Future<Output = Self::Output>, Self: Sized,` [src]

`fn into_stream(self) -> IntoStream<Self> where Self: Sized,` [src]

ⓘImportant traits for Flatten<Fut>
Important traits for Flatten<Fut>
`impl<Fut> Future for Flatten<Fut> where Fut: Future, Fut::Output: Future, type Output = <Fut::Output as Future>::Output;`
`fn flatten(self) -> Flatten<Self> where Self::Output: Future, Self: Sized,` [src]

`fn flatten_stream(self) -> FlattenStream<Self> where Self::Output: Stream, Self: Sized,` [src]

ⓘImportant traits for Fuse<Fut>
Important traits for Fuse<Fut>
`impl<Fut: Future> Future for Fuse<Fut> type Output = Fut::Output;`
`fn fuse(self) -> Fuse<Self> where Self: Sized,` [src]

ⓘImportant traits for Inspect<Fut, F>
Important traits for Inspect<Fut, F>
`impl<Fut, F> Future for Inspect<Fut, F> where Fut: Future, F: FnOnce(&Fut::Output), type Output = Fut::Output;`
`fn inspect<F>(self, f: F) -> Inspect<Self, F> where F: FnOnce(&Self::Output), Self: Sized,` [src]

ⓘImportant traits for CatchUnwind<Fut>
Important traits for CatchUnwind<Fut>
`impl<Fut> Future for CatchUnwind<Fut> where Fut: Future + UnwindSafe, type Output = Result<Fut::Output, Box<dyn Any + Send>>;`
`fn catch_unwind(self) -> CatchUnwind<Self> where Self: Sized + UnwindSafe,` [src]

ⓘImportant traits for Shared<Fut>
Important traits for Shared<Fut>
`impl<Fut> Future for Shared<Fut> where Fut: Future, Fut::Output: Clone, type Output = Fut::Output;`
`fn shared(self) -> Shared<Self> where Self: Sized, Self::Output: Clone,` [src]

`fn remote_handle(self) -> (Remote<Self>, RemoteHandle<Self::Output>) where Self: Sized,` [src]

`fn boxed<'a>(self) -> BoxFuture<'a, Self::Output> where Self: Sized + Send + 'a,` [src]

`fn boxed_local<'a>(self) -> LocalBoxFuture<'a, Self::Output> where Self: Sized + 'a,` [src]

ⓘImportant traits for UnitError<Fut>
Important traits for UnitError<Fut>
`impl<Fut, T> Future for UnitError<Fut> where Fut: Future<Output = T>, type Output = Result<T, ()>;`
`fn unit_error(self) -> UnitError<Self> where Self: Sized,` [src]

ⓘImportant traits for NeverError<Fut>
Important traits for NeverError<Fut>
`impl<Fut, T> Future for NeverError<Fut> where Fut: Future<Output = T>, type Output = Result<T, Never>;`
`fn never_error(self) -> NeverError<Self> where Self: Sized,` [src]

`fn poll_unpin(&mut self, cx: &mut Context) -> Poll<Self::Output> where Self: Unpin,` [src]

`fn now_or_never(self) -> Option<Self::Output> where Self: Sized,` [src]

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

The resulting type after obtaining ownership.

`fn to_owned(&self) -> T`[src]

`fn clone_into(&self, target: &mut T)`[src]

`impl<T, U> Into for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T> From<T> for T`[src]

`fn from(t: T) -> T`[src]

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

`fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`[src]

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

`type Error = >::Error`

The type returned in the event of a conversion error.

`fn try_into(self) -> Result<U, >::Error>`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

ⓘImportant traits for &'_ mut F
Important traits for &'_ mut F
`impl<'_, F> Future for &'_ mut F where F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;`
`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

ⓘImportant traits for &'_ mut F
Important traits for &'_ mut F
`impl<'_, F> Future for &'_ mut F where F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;`
`fn borrow(&self) -> &T`[src]

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`fn type_id(&self) -> TypeId`[src]

[−][src]Struct futures_util::future::OptionFuture

Examples

Trait Implementations

impl<F: Clone> Clone for OptionFuture<F>[src]

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

Important traits for OptionFuture<F>

fn clone_from(&mut self, source: &Self)1.0.0[src]

impl<T> From<Option<T>> for OptionFuture<T>[src]

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

impl<F: Debug> Debug for OptionFuture<F>[src]

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

impl<F: Future> Future for OptionFuture<F>[src]

type Output = Option<F::Output>

fn poll(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Self::Output>[src]

impl<F: FusedFuture> FusedFuture for OptionFuture<F>[src]

fn is_terminated(&self) -> bool[src]

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

impl<T> FutureExt for T where T: Future + ?Sized, [src]

ⓘImportant traits for Map<Fut, F>Important traits for Map<Fut, F>impl<Fut, F, T> Future for Map<Fut, F> where Fut: Future, F: FnOnce(Fut::Output) -> T, type Output = T;fn map<U, F>(self, f: F) -> Map<Self, F> where F: FnOnce(Self::Output) -> U, Self: Sized, [src]

Important traits for Map<Fut, F>

Important traits for Then<Fut1, Fut2, F>

ⓘImportant traits for Either<A, B>Important traits for Either<A, B>impl<A, B> Future for Either<A, B> where A: Future, B: Future<Output = A::Output>, type Output = A::Output;fn left_future<B>(self) -> Either<Self, B> where B: Future<Output = Self::Output>, Self: Sized, [src]

Important traits for Either<A, B>

ⓘImportant traits for Either<A, B>Important traits for Either<A, B>impl<A, B> Future for Either<A, B> where A: Future, B: Future<Output = A::Output>, type Output = A::Output;fn right_future<A>(self) -> Either<A, Self> where A: Future<Output = Self::Output>, Self: Sized, [src]

Important traits for Either<A, B>

fn into_stream(self) -> IntoStream<Self> where Self: Sized, [src]

ⓘImportant traits for Flatten<Fut>Important traits for Flatten<Fut>impl<Fut> Future for Flatten<Fut> where Fut: Future, Fut::Output: Future, type Output = <Fut::Output as Future>::Output;fn flatten(self) -> Flatten<Self> where Self::Output: Future, Self: Sized, [src]

Important traits for Flatten<Fut>

fn flatten_stream(self) -> FlattenStream<Self> where Self::Output: Stream, Self: Sized, [src]

ⓘImportant traits for Fuse<Fut>Important traits for Fuse<Fut>impl<Fut: Future> Future for Fuse<Fut> type Output = Fut::Output;fn fuse(self) -> Fuse<Self> where Self: Sized, [src]

Important traits for Fuse<Fut>

ⓘImportant traits for Inspect<Fut, F>Important traits for Inspect<Fut, F>impl<Fut, F> Future for Inspect<Fut, F> where Fut: Future, F: FnOnce(&Fut::Output), type Output = Fut::Output;fn inspect<F>(self, f: F) -> Inspect<Self, F> where F: FnOnce(&Self::Output), Self: Sized, [src]

Important traits for Inspect<Fut, F>

ⓘImportant traits for CatchUnwind<Fut>Important traits for CatchUnwind<Fut>impl<Fut> Future for CatchUnwind<Fut> where Fut: Future + UnwindSafe, type Output = Result<Fut::Output, Box<dyn Any + Send>>;fn catch_unwind(self) -> CatchUnwind<Self> where Self: Sized + UnwindSafe, [src]

Important traits for CatchUnwind<Fut>

ⓘImportant traits for Shared<Fut>Important traits for Shared<Fut>impl<Fut> Future for Shared<Fut> where Fut: Future, Fut::Output: Clone, type Output = Fut::Output;fn shared(self) -> Shared<Self> where Self: Sized, Self::Output: Clone, [src]

Important traits for Shared<Fut>

fn remote_handle(self) -> (Remote<Self>, RemoteHandle<Self::Output>) where Self: Sized, [src]

fn boxed<'a>(self) -> BoxFuture<'a, Self::Output> where Self: Sized + Send + 'a, [src]

fn boxed_local<'a>(self) -> LocalBoxFuture<'a, Self::Output> where Self: Sized + 'a, [src]

ⓘImportant traits for UnitError<Fut>Important traits for UnitError<Fut>impl<Fut, T> Future for UnitError<Fut> where Fut: Future<Output = T>, type Output = Result<T, ()>;fn unit_error(self) -> UnitError<Self> where Self: Sized, [src]

Important traits for UnitError<Fut>

ⓘImportant traits for NeverError<Fut>Important traits for NeverError<Fut>impl<Fut, T> Future for NeverError<Fut> where Fut: Future<Output = T>, type Output = Result<T, Never>;fn never_error(self) -> NeverError<Self> where Self: Sized, [src]

Important traits for NeverError<Fut>

fn poll_unpin(&mut self, cx: &mut Context) -> Poll<Self::Output> where Self: Unpin, [src]

fn now_or_never(self) -> Option<Self::Output> where Self: Sized, [src]

impl<T> ToOwned for T where T: Clone, [src]

type Owned = T

fn to_owned(&self) -> T[src]

fn clone_into(&self, target: &mut T)[src]

impl<T, U> Into<U> for T where U: From<T>, [src]

fn into(self) -> U[src]

impl<T> From<T> for T[src]

fn from(t: T) -> T[src]

impl<T, U> TryFrom<U> for T where U: Into<T>, [src]

type Error = Infallible

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

impl<T, U> TryInto<U> for T where U: TryFrom<T>, [src]

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

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

impl<T> BorrowMut<T> for T where T: ?Sized, [src]

ⓘImportant traits for &'_ mut FImportant traits for &'_ mut Fimpl<'_, F> Future for &'_ mut F where F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;fn borrow_mut(&mut self) -> &mut T[src]

Important traits for &'_ mut F

impl<T> Borrow<T> for T where T: ?Sized, [src]

ⓘImportant traits for &'_ mut FImportant traits for &'_ mut Fimpl<'_, F> Future for &'_ mut F where F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;fn borrow(&self) -> &T[src]