Struct leak_playground_tokio::task::ScopedJoinHandle

source ·
pub struct ScopedJoinHandle<'a, T> {
    inner: ManuallyDrop<JoinHandle<Payload>>,
    _unforget: Unforget<'static, PhantomData<&'a ()>>,
    _output: PhantomData<T>,
    _unsend: PhantomData<*mut ()>,
}
Expand description

Handle to a task, which cancels on drop.

This is made to ensure we won’t put task into itself, thus forgetting it.

To spawn use spawn_scoped, spawn_local_scoped, or spawn_blocking_scoped.

Fields§

§inner: ManuallyDrop<JoinHandle<Payload>>§_unforget: Unforget<'static, PhantomData<&'a ()>>§_output: PhantomData<T>§_unsend: PhantomData<*mut ()>

Implementations§

source§

impl<'a, T> ScopedJoinHandle<'a, T>

source

pub async fn cancel(self) -> Result<(), JoinError>

source

pub fn abort(&self)

source

pub fn abort_handle(&self) -> AbortHandle

Trait Implementations§

source§

impl<'a, T> Drop for ScopedJoinHandle<'a, T>

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl<'a, T> Future for ScopedJoinHandle<'a, T>

§

type Output = Result<T, JoinError>

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<T: Send> Send for ScopedJoinHandle<'static, T>

source§

impl<T: Send> Sync for ScopedJoinHandle<'_, T>

source§

impl<T> Unpin for ScopedJoinHandle<'_, T>

Auto Trait Implementations§

§

impl<'a, T> Forget for ScopedJoinHandle<'a, T>
where 'a: 'static, T: Forget,

§

impl<'a, T> Freeze for ScopedJoinHandle<'a, T>

§

impl<'a, T> RefUnwindSafe for ScopedJoinHandle<'a, T>
where T: RefUnwindSafe,

§

impl<'a, T> UnwindSafe for ScopedJoinHandle<'a, T>
where T: UnwindSafe,

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

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

§

type Output = <F as Future>::Output

The output that the future will produce on completion.
§

type IntoFuture = F

Which kind of future are we turning this into?
source§

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

Creates a future from a value. Read more
source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.