Struct StoppableHandle

Source
pub struct StoppableHandle<T> { /* private fields */ }
Expand description

A handle for a stoppable thread

The interface is similar to std::thread::JoinHandle<T>, supporting thread and join with the same signature.

Implementations§

Source§

impl<T> StoppableHandle<T>

Source

pub fn thread(&self) -> &Thread

Source

pub fn join(self) -> Result<T>

Source

pub fn stop(self) -> JoinHandle<T>

Stop the thread

This will signal the thread to stop by setting the shared atomic stopped variable to True. The function will return immediately after, to wait for the thread to stop, use the returned JoinHandle<T> and wait().

Auto Trait Implementations§

§

impl<T> Freeze for StoppableHandle<T>

§

impl<T> !RefUnwindSafe for StoppableHandle<T>

§

impl<T> Send for StoppableHandle<T>

§

impl<T> Sync for StoppableHandle<T>

§

impl<T> Unpin for StoppableHandle<T>

§

impl<T> !UnwindSafe for StoppableHandle<T>

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<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

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>,

Source§

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.