Struct futures::future::Shared[−][src]

[+] Show declaration

[+] Expand attributes
#[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.

Implementations

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

`pub fn peek(&self) -> Option<&<Fut as Future>::Output>`[src][−]

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.

`pub fn downgrade(&self) -> Option<WeakShared<Fut>>`[src][−]

Creates a new WeakShared for this Shared.

Returns None if it has already been polled to completion.

`pub fn strong_count(&self) -> Option<usize>`[src][−]

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.

`pub fn weak_count(&self) -> Option<usize>`[src][−]

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.

Struct futures::future::Shared[−][src]

Implementations

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

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

pub fn downgrade(&self) -> Option<WeakShared<Fut>>[src][−]

pub fn strong_count(&self) -> Option<usize>[src][−]

Safety

pub fn weak_count(&self) -> Option<usize>[src][−]

Safety

Trait Implementations

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

pub fn clone(&self) -> Shared<Fut>ⓘNotable traits for Shared<Fut>impl<Fut> Future for Shared<Fut> where Fut: Future, <Fut as Future>::Output: Clone, type Output = <Fut as Future>::Output;[src][−]

Notable traits for Shared<Fut>

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

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

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>[src][−]

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

pub fn drop(&mut self)[src][−]

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

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

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

type Output = <Fut as Future>::Output

pub fn poll( self: Pin<&mut Shared<Fut>>, cx: &mut Context<'_>) -> Poll<<Shared<Fut> as Future>::Output>[src][−]

impl<Fut> Unpin for Shared<Fut> where Fut: Future, [src]

Auto Trait Implementations

impl<Fut> !RefUnwindSafe for Shared<Fut>

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> !UnwindSafe for Shared<Fut>

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized, [src][+]

pub fn type_id(&self) -> TypeId[src][−]

impl<T> Borrow<T> for T where T: ?Sized, [src][+]

pub fn borrow(&self) -> &TⓘNotable traits for &'_ mut Fimpl<'_, F> Future for &'_ mut F where F: Future + Unpin + ?Sized, type Output = <F as Future>::Output;[src][−]

Notable traits for &'_ mut F

impl<T> BorrowMut<T> for T where T: ?Sized, [src][+]

pub fn borrow_mut(&mut self) -> &mut TⓘNotable traits for &'_ mut Fimpl<'_, F> Future for &'_ mut F where F: Future + Unpin + ?Sized, type Output = <F as Future>::Output;[src][−]

Notable traits for &'_ mut F

impl<T> From<T> for T[src][+]

pub fn from(t: T) -> T[src][−]

impl<T> FutureExt for T where T: Future + ?Sized, [src][+]

pub fn map<U, F>(self, f: F) -> Map<Self, F>ⓘNotable traits for Map<Fut, F>impl<Fut, F> Future for Map<Fut, F> where Map<Fut, F>: Future, type Output = <Map<Fut, F> as Future>::Output; where F: FnOnce(Self::Output) -> U, [src][−]

Notable traits for Map<Fut, F>

pub fn map_into<U>(self) -> MapInto<Self, U>ⓘNotable traits for MapInto<Fut, T>impl<Fut, T> Future for MapInto<Fut, T> where Map<Fut, IntoFn<T>>: Future, type Output = <Map<Fut, IntoFn<T>> as Future>::Output; where Self::Output: Into<U>, [src][−]

Notable traits for MapInto<Fut, T>

Notable traits for Then<Fut1, Fut2, F>

pub fn left_future<B>(self) -> Either<Self, B>ⓘNotable traits for Either<A, B>impl<A, B> Future for Either<A, B> where B: Future<Output = <A as Future>::Output>, A: Future, type Output = <A as Future>::Output; where B: Future<Output = Self::Output>, [src][−]

Notable traits for Either<A, B>

pub fn right_future<A>(self) -> Either<A, Self>ⓘNotable traits for Either<A, B>impl<A, B> Future for Either<A, B> where B: Future<Output = <A as Future>::Output>, A: Future, type Output = <A as Future>::Output; where A: Future<Output = Self::Output>, [src][−]

Notable traits for Either<A, B>

pub fn into_stream(self) -> IntoStream<Self>[src][−]

pub fn flatten(self) -> Flatten<Self>ⓘNotable traits for Flatten<F>impl<F> Future for Flatten<F> where F: Future, Flatten<F, <F as Future>::Output>: Future, type Output = <Flatten<F, <F as Future>::Output> as Future>::Output; where Self::Output: Future, [src][−]

Notable traits for Flatten<F>

pub fn flatten_stream(self) -> FlattenStream<Self> where Self::Output: Stream, [src][−]

pub fn fuse(self) -> Fuse<Self>ⓘNotable traits for Fuse<Fut>impl<Fut> Future for Fuse<Fut> where Fut: Future, type Output = <Fut as Future>::Output;[src][−]

Notable traits for Fuse<Fut>

pub fn inspect<F>(self, f: F) -> Inspect<Self, F>ⓘNotable traits for Inspect<Fut, F>impl<Fut, F> Future for Inspect<Fut, F> where Map<Fut, InspectFn<F>>: Future, type Output = <Map<Fut, InspectFn<F>> as Future>::Output; where F: FnOnce(&Self::Output), [src][−]

Notable traits for Inspect<Fut, F>

pub fn catch_unwind(self) -> CatchUnwind<Self>ⓘNotable traits for CatchUnwind<Fut>impl<Fut> Future for CatchUnwind<Fut> where Fut: Future + UnwindSafe, type Output = Result<<Fut as Future>::Output, Box<dyn Any + 'static + Send, Global>>; where Self: UnwindSafe, [src][−]

Notable traits for CatchUnwind<Fut>

pub fn shared(self) -> Shared<Self>ⓘNotable traits for Shared<Fut>impl<Fut> Future for Shared<Fut> where Fut: Future, <Fut as Future>::Output: Clone, type Output = <Fut as Future>::Output; where Self::Output: Clone, [src][−]

Notable traits for Shared<Fut>

pub fn remote_handle(self) -> (Remote<Self>, RemoteHandle<Self::Output>)[src][−]

pub fn boxed<'a>( self) -> Pin<Box<dyn Future<Output = Self::Output> + 'a + Send, Global>>ⓘNotable traits for Pin<P>impl<P> Future for Pin<P> where P: Unpin + DerefMut, <P as Deref>::Target: Future, type Output = <<P as Deref>::Target as Future>::Output; where Self: Send + 'a, [src][−]

Notable traits for Pin<P>

pub fn boxed_local<'a>( self) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>>ⓘNotable traits for Pin<P>impl<P> Future for Pin<P> where P: Unpin + DerefMut, <P as Deref>::Target: Future, type Output = <<P as Deref>::Target as Future>::Output; where Self: 'a, [src][−]

Notable traits for Pin<P>

pub fn unit_error(self) -> UnitError<Self>ⓘNotable traits for UnitError<Fut>impl<Fut> Future for UnitError<Fut> where Map<Fut, OkFn<()>>: Future, type Output = <Map<Fut, OkFn<()>> as Future>::Output;[src][−]

Notable traits for UnitError<Fut>

pub fn never_error(self) -> NeverError<Self>ⓘNotable traits for NeverError<Fut>impl<Fut> Future for NeverError<Fut> where Map<Fut, OkFn<Infallible>>: Future, type Output = <Map<Fut, OkFn<Infallible>> as Future>::Output;[src][−]

Notable traits for NeverError<Fut>

pub fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where Self: Unpin, [src][−]

pub fn now_or_never(self) -> Option<Self::Output>[src][−]

impl<T, U> Into<U> for T where U: From<T>, [src][+]

pub fn into(self) -> U[src][−]

impl<F> IntoFuture for F where F: Future, [src][+]

type Output = <F as Future>::Output

type Future = F

pub fn into_future(self) -> <F as IntoFuture>::Future[src][−]

impl<T> ToOwned for T where T: Clone, [src][+]

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

`pub fn peek(&self) -> Option<&<Fut as Future>::Output>`[src][−]

`pub fn downgrade(&self) -> Option<WeakShared<Fut>>`[src][−]

`pub fn strong_count(&self) -> Option<usize>`[src][−]

`pub fn weak_count(&self) -> Option<usize>`[src][−]

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

`pub fn clone(&self) -> Shared<Fut>ⓘNotable traits for Shared<Fut> impl<Fut> Future for Shared<Fut> where Fut: Future, <Fut as Future>::Output: Clone, type Output = <Fut as Future>::Output;`[src][−]

`pub fn clone_from(&mut self, source: &Self)`1.0.0[src][−]

`impl<Fut> Debug for Shared<Fut> where Fut: Future,` [src][+]

`pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>`[src][−]

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

`pub fn drop(&mut self)`[src][−]

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

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

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

`type Output = <Fut as Future>::Output`

`pub fn poll( self: Pin<&mut Shared<Fut>>, cx: &mut Context<'_> ) -> Poll<<Shared<Fut> as Future>::Output>`[src][−]

`impl<Fut> Unpin for Shared<Fut> where Fut: Future,` [src]

`impl<Fut> !RefUnwindSafe for Shared<Fut>`

`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> !UnwindSafe for Shared<Fut>`

`impl<T> Any for T where T: 'static + ?Sized,` [src][+]

`pub fn type_id(&self) -> TypeId`[src][−]

`impl<T> Borrow<T> for T where T: ?Sized,` [src][+]

`pub fn borrow(&self) -> &TⓘNotable traits for &'_ mut F impl<'_, F> Future for &'_ mut F where F: Future + Unpin + ?Sized, type Output = <F as Future>::Output;`[src][−]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src][+]

`pub fn borrow_mut(&mut self) -> &mut TⓘNotable traits for &'_ mut F impl<'_, F> Future for &'_ mut F where F: Future + Unpin + ?Sized, type Output = <F as Future>::Output;`[src][−]

`impl<T> From<T> for T`[src][+]

`pub fn from(t: T) -> T`[src][−]

`impl<T> FutureExt for T where T: Future + ?Sized,` [src][+]

`pub fn map<U, F>(self, f: F) -> Map<Self, F>ⓘNotable traits for Map<Fut, F> impl<Fut, F> Future for Map<Fut, F> where Map<Fut, F>: Future, type Output = <Map<Fut, F> as Future>::Output; where F: FnOnce(Self::Output) -> U,` [src][−]

`pub fn map_into<U>(self) -> MapInto<Self, U>ⓘNotable traits for MapInto<Fut, T> impl<Fut, T> Future for MapInto<Fut, T> where Map<Fut, IntoFn<T>>: Future, type Output = <Map<Fut, IntoFn<T>> as Future>::Output; where Self::Output: Into<U>,` [src][−]

`pub fn left_future<B>(self) -> Either<Self, B>ⓘNotable traits for Either<A, B> impl<A, B> Future for Either<A, B> where B: Future<Output = <A as Future>::Output>, A: Future, type Output = <A as Future>::Output; where B: Future<Output = Self::Output>,` [src][−]

`pub fn right_future<A>(self) -> Either<A, Self>ⓘNotable traits for Either<A, B> impl<A, B> Future for Either<A, B> where B: Future<Output = <A as Future>::Output>, A: Future, type Output = <A as Future>::Output; where A: Future<Output = Self::Output>,` [src][−]

`pub fn into_stream(self) -> IntoStream<Self>`[src][−]

`pub fn flatten(self) -> Flatten<Self>ⓘNotable traits for Flatten<F> impl<F> Future for Flatten<F> where F: Future, Flatten<F, <F as Future>::Output>: Future, type Output = <Flatten<F, <F as Future>::Output> as Future>::Output; where Self::Output: Future,` [src][−]

`pub fn flatten_stream(self) -> FlattenStream<Self> where Self::Output: Stream,` [src][−]

`pub fn fuse(self) -> Fuse<Self>ⓘNotable traits for Fuse<Fut> impl<Fut> Future for Fuse<Fut> where Fut: Future, type Output = <Fut as Future>::Output;`[src][−]

`pub fn inspect<F>(self, f: F) -> Inspect<Self, F>ⓘNotable traits for Inspect<Fut, F> impl<Fut, F> Future for Inspect<Fut, F> where Map<Fut, InspectFn<F>>: Future, type Output = <Map<Fut, InspectFn<F>> as Future>::Output; where F: FnOnce(&Self::Output),` [src][−]

`pub fn catch_unwind(self) -> CatchUnwind<Self>ⓘNotable traits for CatchUnwind<Fut> impl<Fut> Future for CatchUnwind<Fut> where Fut: Future + UnwindSafe, type Output = Result<<Fut as Future>::Output, Box<dyn Any + 'static + Send, Global>>; where Self: UnwindSafe,` [src][−]

`pub fn shared(self) -> Shared<Self>ⓘNotable traits for Shared<Fut> impl<Fut> Future for Shared<Fut> where Fut: Future, <Fut as Future>::Output: Clone, type Output = <Fut as Future>::Output; where Self::Output: Clone,` [src][−]

`pub fn remote_handle(self) -> (Remote<Self>, RemoteHandle<Self::Output>)`[src][−]

`pub fn boxed<'a>( self ) -> Pin<Box<dyn Future<Output = Self::Output> + 'a + Send, Global>>ⓘNotable traits for Pin<P> impl<P> Future for Pin<P> where P: Unpin + DerefMut, <P as Deref>::Target: Future, type Output = <<P as Deref>::Target as Future>::Output; where Self: Send + 'a,` [src][−]

`pub fn boxed_local<'a>( self ) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>>ⓘNotable traits for Pin<P> impl<P> Future for Pin<P> where P: Unpin + DerefMut, <P as Deref>::Target: Future, type Output = <<P as Deref>::Target as Future>::Output; where Self: 'a,` [src][−]

`pub fn unit_error(self) -> UnitError<Self>ⓘNotable traits for UnitError<Fut> impl<Fut> Future for UnitError<Fut> where Map<Fut, OkFn<()>>: Future, type Output = <Map<Fut, OkFn<()>> as Future>::Output;`[src][−]

`pub fn never_error(self) -> NeverError<Self>ⓘNotable traits for NeverError<Fut> impl<Fut> Future for NeverError<Fut> where Map<Fut, OkFn<Infallible>>: Future, type Output = <Map<Fut, OkFn<Infallible>> as Future>::Output;`[src][−]

`pub fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where Self: Unpin,` [src][−]

`pub fn now_or_never(self) -> Option<Self::Output>`[src][−]

`impl<T, U> Into<U> for T where U: From<T>,` [src][+]

`pub fn into(self) -> U`[src][−]

`impl<F> IntoFuture for F where F: Future,` [src][+]

`type Output = <F as Future>::Output`

`type Future = F`

`pub fn into_future(self) -> <F as IntoFuture>::Future`[src][−]

`impl<T> ToOwned for T where T: Clone,` [src][+]

`type Owned = T`

`pub fn to_owned(&self) -> T`[src][−]

`pub fn clone_into(&self, target: &mut T)`[src][−]

`impl<T, U> TryFrom<U> for T where U: Into<T>,` [src][+]

`type Error = Infallible`

`pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src][−]

`impl<F, T, E> TryFuture for F where F: Future<Output = Result<T, E>> + ?Sized,` [src][+]

`type Ok = T`

`type Error = E`

`pub fn try_poll( self: Pin<&mut F>, cx: &mut Context<'_> ) -> Poll<<F as Future>::Output>`[src][−]

`impl<Fut> TryFutureExt for Fut where Fut: TryFuture + ?Sized,` [src][+]

`pub fn flatten_sink<Item>(self) -> FlattenSink<Self, Self::Ok> where Self::Ok: Sink<Item>, <Self::Ok as Sink<Item>>::Error == Self::Error,` [src][−]

`pub fn map_ok<T, F>(self, f: F) -> MapOk<Self, F>ⓘNotable traits for MapOk<Fut, F> impl<Fut, F> Future for MapOk<Fut, F> where Map<IntoFuture<Fut>, MapOkFn<F>>: Future, type Output = <Map<IntoFuture<Fut>, MapOkFn<F>> as Future>::Output; where F: FnOnce(Self::Ok) -> T,` [src][−]

`pub fn map_err<E, F>(self, f: F) -> MapErr<Self, F>ⓘNotable traits for MapErr<Fut, F> impl<Fut, F> Future for MapErr<Fut, F> where Map<IntoFuture<Fut>, MapErrFn<F>>: Future, type Output = <Map<IntoFuture<Fut>, MapErrFn<F>> as Future>::Output; where F: FnOnce(Self::Error) -> E,` [src][−]

`pub fn err_into<E>(self) -> ErrInto<Self, E>ⓘNotable traits for ErrInto<Fut, E> impl<Fut, E> Future for ErrInto<Fut, E> where MapErr<Fut, IntoFn<E>>: Future, type Output = <MapErr<Fut, IntoFn<E>> as Future>::Output; where Self::Error: Into<E>,` [src][−]

`pub fn ok_into<U>(self) -> OkInto<Self, U>ⓘNotable traits for OkInto<Fut, E> impl<Fut, E> Future for OkInto<Fut, E> where MapOk<Fut, IntoFn<E>>: Future, type Output = <MapOk<Fut, IntoFn<E>> as Future>::Output; where Self::Ok: Into<U>,` [src][−]

`pub fn try_flatten_stream(self) -> TryFlattenStream<Self> where Self::Ok: TryStream, <Self::Ok as TryStream>::Error == Self::Error,` [src][−]

`pub fn into_future(self) -> IntoFuture<Self>ⓘNotable traits for IntoFuture<Fut> impl<Fut> Future for IntoFuture<Fut> where Fut: TryFuture, type Output = Result<<Fut as TryFuture>::Ok, <Fut as TryFuture>::Error>;`[src][−]

`pub fn try_poll_unpin( &mut self, cx: &mut Context<'_> ) -> Poll<Result<Self::Ok, Self::Error>> where Self: Unpin,` [src][−]

`impl<T, U> TryInto<U> for T where U: TryFrom<T>,` [src][+]

`type Error = <U as TryFrom<T>>::Error`

`pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src][−]