Struct futures::future::Shared

#[must_use = "futures do nothing unless you `.await` or poll them"]
pub struct Shared<Fut> where
    Fut: Future,  { /* fields omitted */ }

Future for the shared method.

Methods

impl<Fut> Shared<Fut> where
    Fut: Future,
    <Fut as Future>::Output: Clone, 

pub fn peek(&self) -> Option<&<Fut as Future>::Output>

Returns Some containing a reference to this Shared's output if it has already been computed by a clone or None if it hasn't been computed yet or this Shared already returned its output from poll.

Trait Implementations

impl<Fut> FusedFuture for Shared<Fut> where
    Fut: Future,
    <Fut as Future>::Output: Clone, 

fn is_terminated(&self) -> bool

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

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

fn drop(&mut self)

Executes the destructor for this type.

impl<Fut> Future for Shared<Fut> where
    Fut: Future,
    <Fut as Future>::Output: Clone, 

type Output = <Fut as Future>::Output

The type of value produced on completion.

fn poll(
    self: Pin<&mut Shared<Fut>>,
    cx: &mut Context
) -> Poll<<Shared<Fut> as Future>::Output>

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

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

Important traits for Shared<Fut>

impl<Fut> Future for Shared<Fut> where
    Fut: Future,
    <Fut as Future>::Output: Clone,  type Output = <Fut as Future>::Output;

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Fut> Unpin for Shared<Fut> where
    Fut: Future, 

impl<Fut> Debug for Shared<Fut> where
    Fut: Future, 

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

Formats the value using the given formatter.