Struct stop_token::StopToken [−][src]
StopToken is a future which completes when the associated StopSource is dropped.
Implementations
impl StopToken[src]
pub fn stop_stream<S: Stream>(&self, stream: S) -> StopStream<S>[src]
Applies the token to the stream, such that the resulting stream
produces no more items once the token becomes cancelled.
pub fn stop_future<F: Future>(&self, future: F) -> StopFuture<F>ⓘNotable traits for StopFuture<F>
impl<F: Future> Future for StopFuture<F> type Output = Option<F::Output>;[src]
Notable traits for StopFuture<F>
impl<F: Future> Future for StopFuture<F> type Output = Option<F::Output>;Applies the token to the future, such that the resulting future
completes with None if the token is cancelled.
Trait Implementations
impl Clone for StopToken[src]
impl Debug for StopToken[src]
impl Future for StopToken[src]
Auto Trait Implementations
impl RefUnwindSafe for StopToken[src]
impl Send for StopToken[src]
impl Sync for StopToken[src]
impl Unpin for StopToken[src]
impl UnwindSafe for StopToken[src]
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> FutureExt for T where
T: Future + ?Sized, [src]
T: Future + ?Sized,
impl<F> FutureExt for F where
F: Future + ?Sized,
F: Future + ?Sized,
pub fn poll(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where
Self: Unpin,
Self: Unpin,
pub fn or<F>(self, other: F) -> Or<Self, F> where
F: Future<Output = Self::Output>,
F: Future<Output = Self::Output>,
pub fn race<F>(self, other: F) -> Race<Self, F> where
F: Future<Output = Self::Output>,
F: Future<Output = Self::Output>,
pub fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe,
Self: UnwindSafe,
pub fn boxed<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a + Send, Global>> where
Self: Send + 'a,
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a + Send, Global>> where
Self: Send + 'a,
pub fn boxed_local<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where
Self: 'a,
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where
Self: 'a,
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<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]
U: TryFrom<T>,