Struct glib::JoinHandle

pub struct JoinHandle<T> { /* private fields */ }

A handle to a task running on a MainContext.

Like std::thread::JoinHandle for a task rather than a thread. The return value from the task can be retrieved by awaiting on this object. Dropping the handle “detaches” the task, allowing it to complete but discarding the return value.

Implementations

impl<T> JoinHandle<T>

pub fn as_raw_source_id(&self) -> Option<u32>

Returns the internal source ID.

Returns None if the handle was aborted already.

pub fn abort(&self)

Aborts the task associated with the handle.

pub fn source(&self) -> &Source

Returns the Source associated with this handle.

pub fn into_source_id(self) -> Result<SourceId, Self>

Safely converts the handle into a SourceId.

Can be used to discard the return value while still retaining the ability to abort the underlying task. Returns Err(self) if the handle was aborted already.

Trait Implementations

impl<T: Debug> Debug for JoinHandle<T>

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

Formats the value using the given formatter.

impl<T: 'static> FusedFuture for JoinHandle<T>

fn is_terminated(&self) -> bool

Returns true if the underlying future should no longer be polled.

impl<T: 'static> Future for JoinHandle<T>

type Output = Result<T, JoinError>

The type of value produced on completion.

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.

impl<T> Send for JoinHandle<T>