Struct stop_token::StopToken

source · [−]

pub struct StopToken { /* private fields */ }

Expand description

StopToken is a future which completes when the associated StopSource is dropped.

Trait Implementations

source

impl Clone for StopToken

source

fn clone(&self) -> StopTokenⓘ
Notable traits for StopToken
`impl Future for StopToken type Output = ();`

Returns a copy of the value. Read more

1.0.0 · source

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

source

impl Debug for StopToken

source

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

source

impl Future for StopToken

type Output = ()

The type of value produced on completion.

source

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more

source

impl Into<Deadline> for StopToken

source

fn into(self) -> Deadlineⓘ
Notable traits for Deadline
`impl Future for Deadline type Output = ();`

Performs the conversion.

Auto Trait Implementations

impl RefUnwindSafe for StopToken

impl Send for StopToken

impl Sync for StopToken

impl Unpin for StopToken

impl UnwindSafe for StopToken

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

source

pub fn from(t: T) -> T

Performs the conversion.

source

impl<F> FutureExt for F where
F: Future,

source

fn timeout_at<T>(self, target: T) -> TimeoutAt<Self>ⓘ
Notable traits for TimeoutAt<F>
`impl<F> Future for TimeoutAt<F> where F: Future, type Output = Result<F::Output, TimedOutError>;`
where
 Self: Sized,
 T: Into<Deadline>,

Run a future until it resolves, or until a deadline is hit.

impl<F> FutureExt for F where
F: Future + ?Sized,

fn poll(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where
Self: Unpin,

A convenience for calling Future::poll() on !Unpin types.

fn or<F>(self, other: F) -> Or<Self, F> where
F: Future<Output = Self::Output>,

Returns the result of self or other future, preferring self if both are ready. Read more

fn race<F>(self, other: F) -> Race<Self, F> where
F: Future<Output = Self::Output>,

Returns the result of self or other future, with no preference if both are ready. Read more

fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe,

Catches panics while polling the future. Read more

fn boxed<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + Send + 'a, Global>> where
Self: 'a + Send,

Boxes the future and changes its type to dyn Future + Send + 'a. Read more

fn boxed_local<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where
Self: 'a,

Boxes the future and changes its type to dyn Future + 'a. Read more

source

impl<T, U> Into for T where
U: From<T>,

source

pub fn into(self) -> U

Performs the conversion.

source

impl<F> IntoFuture for F where
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?

source

pub fn into_future(self) -> <F as IntoFuture>::Future

🔬 This is a nightly-only experimental API. (into_future)

Creates a future from a value.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct stop_token::StopToken

Trait Implementations

impl Clone for StopToken

fn clone(&self) -> StopTokenⓘNotable traits for StopTokenimpl Future for StopToken type Output = ();

fn clone_from(&mut self, source: &Self)

impl Debug for StopToken

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl Future for StopToken

type Output = ()

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

impl Into<Deadline> for StopToken

fn into(self) -> DeadlineⓘNotable traits for Deadlineimpl Future for Deadline type Output = ();

Auto Trait Implementations

impl RefUnwindSafe for StopToken

impl Send for StopToken

impl Sync for StopToken

impl Unpin for StopToken

impl UnwindSafe for StopToken

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<F> FutureExt for F where F: Future,

fn timeout_at<T>(self, target: T) -> TimeoutAt<Self>ⓘNotable traits for TimeoutAt<F>impl<F> Future for TimeoutAt<F> where F: Future, type Output = Result<F::Output, TimedOutError>; where Self: Sized, T: Into<Deadline>,

impl<F> FutureExt for F where F: Future + ?Sized,

fn poll(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where Self: Unpin,

fn or<F>(self, other: F) -> Or<Self, F> where F: Future<Output = Self::Output>,

fn race<F>(self, other: F) -> Race<Self, F> where F: Future<Output = Self::Output>,

fn catch_unwind(self) -> CatchUnwind<Self> where Self: UnwindSafe,

fn boxed<'a>( self) -> Pin<Box<dyn Future<Output = Self::Output> + Send + 'a, Global>> where Self: 'a + Send,

fn boxed_local<'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>,

pub fn into(self) -> U

impl<F> IntoFuture for F where F: Future,

type Output = <F as Future>::Output

type Future = F

pub fn into_future(self) -> <F as IntoFuture>::Future

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

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

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

fn clone(&self) -> StopTokenⓘ
Notable traits for StopToken
`impl Future for StopToken type Output = ();`

fn into(self) -> Deadlineⓘ
Notable traits for Deadline
`impl Future for Deadline type Output = ();`

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

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<F> FutureExt for F where
F: Future,

fn timeout_at<T>(self, target: T) -> TimeoutAt<Self>ⓘ
Notable traits for TimeoutAt<F>
`impl<F> Future for TimeoutAt<F> where F: Future, type Output = Result<F::Output, TimedOutError>;`
where
Self: Sized,
T: Into<Deadline>,

impl<F> FutureExt for F where
F: Future + ?Sized,

fn poll(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where
Self: Unpin,

fn or<F>(self, other: F) -> Or<Self, F> where
F: Future<Output = Self::Output>,

fn race<F>(self, other: F) -> Race<Self, F> where
F: Future<Output = Self::Output>,

fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe,

fn boxed<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + Send + 'a, Global>> where
Self: 'a + Send,

fn boxed_local<'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>,

impl<F> IntoFuture for F where
F: Future,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,