Struct futures_util::future::Shared

source ·
pub struct Shared<Fut: Future> { /* private fields */ }
Expand description

Future for the shared method.

Implementations§

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.

Creates a new WeakShared for this Shared.

Returns None if it has already been polled to completion.

Gets the number of strong pointers to this allocation.

Returns None if it has already been polled to completion.

Safety

This method by itself is safe, but using it correctly requires extra care. Another thread can change the strong count at any time, including potentially between calling this method and acting on the result.

Gets the number of weak pointers to this allocation.

Returns None if it has already been polled to completion.

Safety

This method by itself is safe, but using it correctly requires extra care. Another thread can change the weak count at any time, including potentially between calling this method and acting on the result.

Hashes the internal state of this Shared in a way that’s compatible with ptr_eq.

Returns true if the two Shareds point to the same future (in a vein similar to Arc::ptr_eq).

Returns false if either Shared has terminated.

Trait Implementations§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Executes the destructor for this type. Read more
Returns true if the underlying future should no longer be polled.
The type of value produced on completion.
Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

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

The output that the future will produce on completion.
Which kind of future are we turning this into?
Creates a future from a value. Read more
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type of successful values yielded by this future
The type of failures yielded by this future
Poll this TryFuture as if it were a Future. Read more
The type returned in the event of a conversion error.
Performs the conversion.