Struct hyena::Task

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

A task that can be spawned onto a TaskPool.

Note Tasks are cancelled when dropped.

Implementations

impl<T> Task<T>

pub fn new(inner: Task<T>) -> Self

Creates a new task from the wrapped task.

pub fn is_finished(&self) -> bool

Returns true if the task has completed.

pub fn detach(self)

Detaches the task, causing it to run in the background.

pub async fn cancel(self)

Cancels the task and waits for it to cancel. As opposed to dropping it.

pub fn cancel_blocking(self)

Cancels the task and waits for it to cancel.

This is equivalent to blocking on Task::cancel.

pub fn block_on(self) -> T

Runs the task to completion.

Trait Implementations

impl<T: Debug> Debug for Task<T>

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

Formats the value using the given formatter.

impl<T> Future for Task<T>

type Output = T

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.