[−][src]Struct futures_util::future::Shared
#[must_use = "futures do nothing unless polled"]pub struct Shared<Fut: 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<Fut> Shared<Fut> where
Fut: Future,
Fut::Output: Clone, [src]
impl<Fut> Shared<Fut> where
Fut: Future,
Fut::Output: Clone, pub fn peek(&self) -> Option<Fut::Output>[src]
pub fn peek(&self) -> Option<Fut::Output>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<Fut: Future> Unpin for Shared<Fut>[src]
impl<Fut: Future> Unpin for Shared<Fut>impl<Fut: Future> Debug for Shared<Fut>[src]
impl<Fut: Future> Debug for Shared<Fut>fn fmt(&self, fmt: &mut Formatter) -> Result[src]
fn fmt(&self, fmt: &mut Formatter) -> ResultFormats the value using the given formatter. Read more
impl<Fut: Future> Future for Shared<Fut> where
Fut::Output: Clone, [src]
impl<Fut: Future> Future for Shared<Fut> where
Fut::Output: Clone, type Output = Fut::Output
🔬 This is a nightly-only experimental API. (futures_api)
futures in libcore are unstable
The result of the Future.
fn poll(self: PinMut<Self>, cx: &mut Context) -> Poll<Self::Output>[src]
fn poll(self: PinMut<Self>, cx: &mut Context) -> Poll<Self::Output>🔬 This is a nightly-only experimental API. (futures_api)
futures in libcore are unstable
Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more
impl<Fut> Clone for Shared<Fut> where
Fut: Future, [src]
impl<Fut> Clone for Shared<Fut> where
Fut: Future, fn clone(&self) -> Self[src]
fn clone(&self) -> SelfReturns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)1.0.0[src]
fn clone_from(&mut self, source: &Self)Performs copy-assignment from source. Read more
impl<Fut> Drop for Shared<Fut> where
Fut: Future, [src]
impl<Fut> Drop for Shared<Fut> where
Fut: Future, Auto Trait Implementations
impl<Fut> Send for Shared<Fut> where
Fut: Send,
<Fut as Future>::Output: Send + Sync,
impl<Fut> Send for Shared<Fut> where
Fut: Send,
<Fut as Future>::Output: Send + Sync, impl<Fut> Sync for Shared<Fut> where
Fut: Send,
<Fut as Future>::Output: Send + Sync,
impl<Fut> Sync for Shared<Fut> where
Fut: Send,
<Fut as Future>::Output: Send + Sync, Blanket Implementations
impl<T> FutureExt for T where
T: Future + ?Sized, [src]
impl<T> FutureExt for T where
T: Future + ?Sized, fn map<U, F>(self, f: F) -> Map<Self, F> where
F: FnOnce(Self::Output) -> U,
Self: Sized, [src]
fn map<U, F>(self, f: F) -> Map<Self, F> where
F: FnOnce(Self::Output) -> U,
Self: Sized, Map this future's output to a different type, returning a new future of the resulting type. Read more
fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where
F: FnOnce(Self::Output) -> Fut,
Fut: Future,
Self: Sized, [src]
fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where
F: FnOnce(Self::Output) -> Fut,
Fut: Future,
Self: Sized, Chain on a computation for when a future finished, passing the result of the future to the provided closure f. Read more
fn join<Fut2>(self, other: Fut2) -> Join<Self, Fut2> where
Fut2: Future,
Self: Sized, [src]
fn join<Fut2>(self, other: Fut2) -> Join<Self, Fut2> where
Fut2: Future,
Self: Sized, Joins the result of two futures, waiting for them both to complete. Read more
fn join3<Fut2, Fut3>(
self,
future2: Fut2,
future3: Fut3
) -> Join3<Self, Fut2, Fut3> where
Fut2: Future,
Fut3: Future,
Self: Sized, [src]
fn join3<Fut2, Fut3>(
self,
future2: Fut2,
future3: Fut3
) -> Join3<Self, Fut2, Fut3> where
Fut2: Future,
Fut3: Future,
Self: Sized, Same as join, but with more futures. Read more
fn join4<Fut2, Fut3, Fut4>(
self,
future2: Fut2,
future3: Fut3,
future4: Fut4
) -> Join4<Self, Fut2, Fut3, Fut4> where
Fut2: Future,
Fut3: Future,
Fut3: Future,
Fut4: Future,
Self: Sized, [src]
fn join4<Fut2, Fut3, Fut4>(
self,
future2: Fut2,
future3: Fut3,
future4: Fut4
) -> Join4<Self, Fut2, Fut3, Fut4> where
Fut2: Future,
Fut3: Future,
Fut3: Future,
Fut4: Future,
Self: Sized, Same as join, but with more futures. Read more
fn join5<Fut2, Fut3, Fut4, Fut5>(
self,
future2: Fut2,
future3: Fut3,
future4: Fut4,
future5: Fut5
) -> Join5<Self, Fut2, Fut3, Fut4, Fut5> where
Fut2: Future,
Fut3: Future,
Fut3: Future,
Fut4: Future,
Fut5: Future,
Self: Sized, [src]
fn join5<Fut2, Fut3, Fut4, Fut5>(
self,
future2: Fut2,
future3: Fut3,
future4: Fut4,
future5: Fut5
) -> Join5<Self, Fut2, Fut3, Fut4, Fut5> where
Fut2: Future,
Fut3: Future,
Fut3: Future,
Fut4: Future,
Fut5: Future,
Self: Sized, Same as join, but with more futures. Read more
fn into_stream(self) -> IntoStream<Self> where
Self: Sized, [src]
fn into_stream(self) -> IntoStream<Self> where
Self: Sized, Convert this future into a single element stream. Read more
fn flatten(self) -> Flatten<Self> where
Self::Output: Future,
Self: Sized, [src]
fn flatten(self) -> Flatten<Self> where
Self::Output: Future,
Self: Sized, Flatten the execution of this future when the successful result of this future is itself another future. Read more
fn flatten_stream(self) -> FlattenStream<Self> where
Self::Output: Stream,
Self: Sized, [src]
fn flatten_stream(self) -> FlattenStream<Self> where
Self::Output: Stream,
Self: Sized, Flatten the execution of this future when the successful result of this future is a stream. Read more
fn fuse(self) -> Fuse<Self> where
Self: Sized, [src]
fn fuse(self) -> Fuse<Self> where
Self: Sized, Fuse a future such that poll will never again be called once it has completed. Read more
fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnOnce(&Self::Output),
Self: Sized, [src]
fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnOnce(&Self::Output),
Self: Sized, Do something with the output of a future before passing it on. Read more
fn catch_unwind(self) -> CatchUnwind<Self> where
Self: Sized + UnwindSafe, [src]
fn catch_unwind(self) -> CatchUnwind<Self> where
Self: Sized + UnwindSafe, Catches unwinding panics while polling the future. Read more
Create a cloneable handle to this future where all handles will resolve to the same result. Read more
fn boxed(self) -> PinBox<Self> where
Self: Sized, [src]
fn boxed(self) -> PinBox<Self> where
Self: Sized, Wrap the future in a Box, pinning it.
fn unit_error(self) -> UnitError<Self> where
Self: Sized, [src]
fn unit_error(self) -> UnitError<Self> where
Self: Sized, Turns a Future into a TryFuture with Error = ().
fn with_spawner<Sp>(self, spawner: Sp) -> WithSpawner<Self, Sp> where
Self: Sized,
Sp: Spawn, [src]
fn with_spawner<Sp>(self, spawner: Sp) -> WithSpawner<Self, Sp> where
Self: Sized,
Sp: Spawn, Assigns the provided Spawn to be used when spawning tasks from within the future. Read more
fn poll_unpin(&mut self, cx: &mut Context) -> Poll<Self::Output> where
Self: Unpin + Sized, [src]
fn poll_unpin(&mut self, cx: &mut Context) -> Poll<Self::Output> where
Self: Unpin + Sized, A convenience for calling Future::poll on Unpin future types.
impl<Fut> TryFutureExt for Fut where
Fut: TryFuture, [src]
impl<Fut> TryFutureExt for Fut where
Fut: TryFuture, fn flatten_sink(self) -> FlattenSink<Self, Self::Ok> where
Self::Ok: Sink<SinkError = Self::Error>,
Self: Sized, [src]
fn flatten_sink(self) -> FlattenSink<Self, Self::Ok> where
Self::Ok: Sink<SinkError = Self::Error>,
Self: Sized, Flattens the execution of this future when the successful result of this future is a Sink. Read more
fn map_ok<T, F>(self, f: F) -> MapOk<Self, F> where
F: FnOnce(Self::Ok) -> T,
Self: Sized, [src]
fn map_ok<T, F>(self, f: F) -> MapOk<Self, F> where
F: FnOnce(Self::Ok) -> T,
Self: Sized, Maps this future's success value to a different value. Read more
fn map_err<E, F>(self, f: F) -> MapErr<Self, F> where
F: FnOnce(Self::Error) -> E,
Self: Sized, [src]
fn map_err<E, F>(self, f: F) -> MapErr<Self, F> where
F: FnOnce(Self::Error) -> E,
Self: Sized, Maps this future's error value to a different value. Read more
fn err_into<E>(self) -> ErrInto<Self, E> where
Self: Sized,
Self::Error: Into<E>, [src]
fn err_into<E>(self) -> ErrInto<Self, E> where
Self: Sized,
Self::Error: Into<E>, Maps this future's Error to a new error type using the Into trait. Read more
fn and_then<Fut, F>(self, f: F) -> AndThen<Self, Fut, F> where
F: FnOnce(Self::Ok) -> Fut,
Fut: TryFuture<Error = Self::Error>,
Self: Sized, [src]
fn and_then<Fut, F>(self, f: F) -> AndThen<Self, Fut, F> where
F: FnOnce(Self::Ok) -> Fut,
Fut: TryFuture<Error = Self::Error>,
Self: Sized, Executes another future after this one resolves successfully. The success value is passed to a closure to create this subsequent future. Read more
fn or_else<Fut, F>(self, f: F) -> OrElse<Self, Fut, F> where
F: FnOnce(Self::Error) -> Fut,
Fut: TryFuture<Ok = Self::Ok>,
Self: Sized, [src]
fn or_else<Fut, F>(self, f: F) -> OrElse<Self, Fut, F> where
F: FnOnce(Self::Error) -> Fut,
Fut: TryFuture<Ok = Self::Ok>,
Self: Sized, Executes another future if this one resolves to an error. The error value is passed to a closure to create this subsequent future. Read more
fn unwrap_or_else<F>(self, f: F) -> UnwrapOrElse<Self, F> where
Self: Sized,
F: FnOnce(Self::Error) -> Self::Ok, [src]
fn unwrap_or_else<F>(self, f: F) -> UnwrapOrElse<Self, F> where
Self: Sized,
F: FnOnce(Self::Error) -> Self::Ok, Unwraps this future's ouput, producing a future with this future's Ok type as its Output type. Read more
fn compat<Sp>(self, spawn: Sp) -> Compat<Self, Sp> where
Self: Sized + Unpin,
Sp: Spawn, [src]
fn compat<Sp>(self, spawn: Sp) -> Compat<Self, Sp> where
Self: Sized + Unpin,
Sp: Spawn, Wraps a TryFuture into a future compatable with libraries using futures 0.1 future definitons. Requires the compat feature to enable. Read more
fn into_future(self) -> IntoFuture<Self> where
Self: Sized, [src]
fn into_future(self) -> IntoFuture<Self> where
Self: Sized, fn try_join<Fut2>(self, other: Fut2) -> TryJoin<Self, Fut2> where
Fut2: TryFuture<Error = Self::Error>,
Self: Sized, [src]
fn try_join<Fut2>(self, other: Fut2) -> TryJoin<Self, Fut2> where
Fut2: TryFuture<Error = Self::Error>,
Self: Sized, Joins the result of two futures, waiting for them both to complete or for one to produce an error. Read more
fn try_join3<Fut2, Fut3>(
self,
future2: Fut2,
future3: Fut3
) -> TryJoin3<Self, Fut2, Fut3> where
Fut2: TryFuture<Error = Self::Error>,
Fut3: TryFuture<Error = Self::Error>,
Self: Sized, [src]
fn try_join3<Fut2, Fut3>(
self,
future2: Fut2,
future3: Fut3
) -> TryJoin3<Self, Fut2, Fut3> where
Fut2: TryFuture<Error = Self::Error>,
Fut3: TryFuture<Error = Self::Error>,
Self: Sized, Same as try_join, but with more futures. Read more
fn try_join4<Fut2, Fut3, Fut4>(
self,
future2: Fut2,
future3: Fut3,
future4: Fut4
) -> TryJoin4<Self, Fut2, Fut3, Fut4> where
Fut2: TryFuture<Error = Self::Error>,
Fut3: TryFuture<Error = Self::Error>,
Fut4: TryFuture<Error = Self::Error>,
Self: Sized, [src]
fn try_join4<Fut2, Fut3, Fut4>(
self,
future2: Fut2,
future3: Fut3,
future4: Fut4
) -> TryJoin4<Self, Fut2, Fut3, Fut4> where
Fut2: TryFuture<Error = Self::Error>,
Fut3: TryFuture<Error = Self::Error>,
Fut4: TryFuture<Error = Self::Error>,
Self: Sized, Same as try_join, but with more futures. Read more
fn try_join5<Fut2, Fut3, Fut4, Fut5>(
self,
future2: Fut2,
future3: Fut3,
future4: Fut4,
future5: Fut5
) -> TryJoin5<Self, Fut2, Fut3, Fut4, Fut5> where
Fut2: TryFuture<Error = Self::Error>,
Fut3: TryFuture<Error = Self::Error>,
Fut4: TryFuture<Error = Self::Error>,
Fut5: TryFuture<Error = Self::Error>,
Self: Sized, [src]
fn try_join5<Fut2, Fut3, Fut4, Fut5>(
self,
future2: Fut2,
future3: Fut3,
future4: Fut4,
future5: Fut5
) -> TryJoin5<Self, Fut2, Fut3, Fut4, Fut5> where
Fut2: TryFuture<Error = Self::Error>,
Fut3: TryFuture<Error = Self::Error>,
Fut4: TryFuture<Error = Self::Error>,
Fut5: TryFuture<Error = Self::Error>,
Self: Sized, Same as try_join, but with more futures. Read more
impl<T> From for T[src]
impl<T> From for Timpl<T, U> Into for T where
U: From<T>, [src]
impl<T, U> Into for T where
U: From<T>, impl<T> ToOwned for T where
T: Clone, [src]
impl<T> ToOwned for T where
T: Clone, type Owned = T
fn to_owned(&self) -> T[src]
fn to_owned(&self) -> TCreates owned data from borrowed data, usually by cloning. Read more
fn clone_into(&self, target: &mut T)[src]
fn clone_into(&self, target: &mut T)🔬 This is a nightly-only experimental API. (toowned_clone_into)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T, U> TryFrom for T where
T: From<U>, [src]
impl<T, U> TryFrom for T where
T: From<U>, type Error = !
try_from)The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>try_from)Performs the conversion.
impl<T> Borrow for T where
T: ?Sized, [src]
impl<T> Borrow for T where
T: ?Sized, ⓘImportant traits for &'a mut Rfn borrow(&self) -> &T[src]
fn borrow(&self) -> &TImmutably borrows from an owned value. Read more
impl<T> Any for T where
T: 'static + ?Sized, [src]
impl<T> Any for T where
T: 'static + ?Sized, fn get_type_id(&self) -> TypeId[src]
fn get_type_id(&self) -> TypeId🔬 This is a nightly-only experimental API. (get_type_id)
this method will likely be replaced by an associated static
Gets the TypeId of self. Read more
impl<T, U> TryInto for T where
U: TryFrom<T>, [src]
impl<T, U> TryInto for T where
U: TryFrom<T>, type Error = <U as TryFrom<T>>::Error
try_from)The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>try_from)Performs the conversion.
impl<T> BorrowMut for T where
T: ?Sized, [src]
impl<T> BorrowMut for T where
T: ?Sized, ⓘImportant traits for &'a mut Rfn borrow_mut(&mut self) -> &mut T[src]
fn borrow_mut(&mut self) -> &mut TMutably borrows from an owned value. Read more
impl<F, T, E> TryFuture for F where
F: Future<Output = Result<T, E>>, [src]
impl<F, T, E> TryFuture for F where
F: Future<Output = Result<T, E>>,