Struct futures_util::future::Abortable [−][src]
A future which can be remotely short-circuited using an AbortHandle
.
Implementations
impl<Fut> Abortable<Fut> where
Fut: Future,
[src]
Fut: Future,
pub fn new(future: Fut, reg: AbortRegistration) -> Self
[src]
Creates a new Abortable
future using an existing AbortRegistration
.
AbortRegistration
s can be acquired through AbortHandle::new
.
When abort
is called on the handle tied to reg
or if abort
has
already been called, the future will complete immediately without making
any further progress.
Example:
use futures::future::{Abortable, AbortHandle, Aborted}; let (abort_handle, abort_registration) = AbortHandle::new_pair(); let future = Abortable::new(async { 2 }, abort_registration); abort_handle.abort(); assert_eq!(future.await, Err(Aborted));
Trait Implementations
impl<Fut: Clone> Clone for Abortable<Fut>
[src]
fn clone(&self) -> Abortable<Fut>ⓘ
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<Fut: Debug> Debug for Abortable<Fut>
[src]
impl<Fut> Future for Abortable<Fut> where
Fut: Future,
[src]
Fut: Future,
type Output = Result<Fut::Output, Aborted>
The type of value produced on completion.
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>
[src]
impl<'__pin, Fut> Unpin for Abortable<Fut> where
__Origin<'__pin, Fut>: Unpin,
[src]
__Origin<'__pin, Fut>: Unpin,
Auto Trait Implementations
impl<Fut> Send for Abortable<Fut> where
Fut: Send,
Fut: Send,
impl<Fut> Sync for Abortable<Fut> where
Fut: Sync,
Fut: Sync,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<F> IntoFuture for F where
F: Future,
[src]
F: Future,
type Output = <F as Future>::Output
🔬 This is a nightly-only experimental API. (
into_future
)The output that the future will produce on completion.
type Future = F
🔬 This is a nightly-only experimental API. (
into_future
)Which kind of future are we turning this into?
pub fn into_future(self) -> <F as IntoFuture>::Future
[src]
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
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]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
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]
F: Future<Output = Result<T, E>> + ?Sized,
type Ok = T
The type of successful values yielded by this future
type Error = E
The type of failures yielded by this future
pub fn try_poll(
self: Pin<&mut F>,
cx: &mut Context<'_>
) -> Poll<<F as Future>::Output>
[src]
self: Pin<&mut F>,
cx: &mut Context<'_>
) -> Poll<<F as Future>::Output>
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,