Struct futures::future::Shared

#[must_use = "futures do nothing unless polled"]
pub struct Shared<F> where
    F: Future,  { /* fields omitted */ }

A future that is cloneable and can be polled in multiple threads. Use Future::shared() method to convert any future into a Shared future.

Methods

impl<F> Shared<F> where
    F: Future, 

pub fn peek(
    &self
) -> Option<Result<SharedItem<<F as Future>::Item>, SharedError<<F as Future>::Error>>>

If any clone of this Shared has completed execution, returns its result immediately without blocking. Otherwise, returns None without triggering the work represented by this Shared.

Trait Implementations

impl<F> Debug for Shared<F> where
    F: Future + Debug,
    <F as Future>::Item: Debug,
    <F as Future>::Error: Debug, 

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

Formats the value using the given formatter.

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

type Item = SharedItem<<F as Future>::Item>

A successful value

type Error = SharedError<<F as Future>::Error>

An error

fn poll(
    &mut self,
    cx: &mut Context
) -> Result<Async<<Shared<F> as Future>::Item>, <Shared<F> as Future>::Error>

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

impl<F> Drop for Shared<F> where
    F: Future, 

fn drop(&mut self)

Executes the destructor for this type.

impl<F> Clone for Shared<F> where
    F: Future, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.