Struct WorkTask 

pub struct WorkTask<T: 'static> { /* private fields */ }

The self-referencing struct.

Implementations

impl<T: 'static> WorkTask<T>

pub fn spawn<W>(work: Box<W>) -> (Box<dyn Work<Output = ()>>, Self)

where W: Work<Output = T> + ?Sized,

Create a new WorkTask from an existing Work item.

This does not queue or otherwise execute the Work item, but only creates the task handle. This API is usually used inside WorkSources, and should not be needed by an end user to execute a Work item.

pub fn try_poll(self) -> Result<WorkTaskResult<T>, Self>

Attempt to synchronously poll the task for completion.

If the task has completed, this will yield the task’s output. If the task has not yet completed, the task will be returned for later re-polling.

This is a synchronous alternative to awaiting the task.

use gtether::worker::WorkTask;

let (work, task) = WorkTask::spawn(Box::new(|| true));

let task = task.try_poll()
    .expect_err("task should not be completed");

work.execute();
let output = task.try_poll()
    .expect("task should be completed")
    .expect("task should not be cancelled");
assert_eq!(output, true);

Trait Implementations

impl<T: 'static> Debug for WorkTask<T>

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

Formats the value using the given formatter.

impl<T: 'static> Drop for WorkTask<T>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<T> Future for WorkTask<T>

type Output = Result<T, WorkTaskError>

The type of value produced on completion.

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

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