Struct futures_util::future::Shared

[+] Show declaration

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

[−] Expand description

Future for the shared method.

Methods

impl<Fut> Shared<Fut> where
    Fut: Future,
    Fut::Output: Clone, [−]

pub fn peek(&self) -> Option<&Fut::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> Clone for Shared<Fut> where
    Fut: Future, [+]

[+] Show hidden undocumented items

fn clone(&self) -> Self[−]

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Fut: Future> Debug for Shared<Fut>[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl<Fut> Drop for Shared<Fut> where
    Fut: Future, [+]

[+] Show hidden undocumented items

fn drop(&mut self)[−]

Executes the destructor for this type.

impl<Fut> FusedFuture for Shared<Fut> where
    Fut: Future,
    Fut::Output: Clone, [+]

[+] Show hidden undocumented items

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

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

impl<Fut> Future for Shared<Fut> where
    Fut: Future,
    Fut::Output: Clone, [+]

[+] Show hidden undocumented items

type Output = Fut::Output

The type of value produced on completion.

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.

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