Struct TaskControl

pub struct TaskControl<T, S> { /* private fields */ }

A task wrapper that runs the task asynchronously and provides access to its state.

Implementations

impl<T: AsyncRun<S>, S: 'static + Send> TaskControl<T, S>

pub fn new(task: T) -> Self

Creates the task control, taking the state for the task but not yet creating or starting it.

pub fn has_state(&self) -> bool

Returns true if a task has been inserted.

pub fn is_running(&self) -> bool

Returns true if a task is running.

pub fn task(&self) -> &T

Gets the task.

Panics if the task is running.

pub fn task_mut(&mut self) -> &mut T

Gets the task.

Panics if the task is running.

pub fn state(&self) -> Option<&S>

Gets the transient task state.

Panics if the task is running.

pub fn state_mut(&mut self) -> Option<&mut S>

Gets the transient task state.

Panics if the task is running.

pub fn get(&self) -> (&T, Option<&S>)

Gets the task and its state.

Panics if the task is running.

pub fn get_mut(&mut self) -> (&mut T, Option<&mut S>)

Gets the state and the task.

Panics if the task is running.

pub fn into_inner(self) -> (T, Option<S>)

Retrieves the task and its state.

Panics if the task is running.

pub fn update_with( &mut self, f: impl 'static + Send + FnOnce(&mut T, Option<&mut S>), )

Calls f against the task and its state.

If the task is running, then f will run remotely and will not necessarily finish before this routine returns.

pub fn insert( &mut self, spawn: impl Spawn, name: impl Into<Arc<str>>, state: S, ) -> &mut S

Inserts the state the task object will use to run and starts the backing task, but does not start running it.

pub fn start(&mut self) -> bool

Starts the task if it is not already running.

Returns true if the task is now running (even if it was previously running). Returns false if the task is not running (either because its state has not been inserted, or because it has already completed).

pub async fn stop(&mut self) -> bool

Stops the task, waiting for it to be cancelled.

Returns true if the task was previously running. Returns false if the task was not running, not inserted, or had already completed.

pub fn remove(&mut self) -> S

Removes the task state.

Panics if the task is not stopped.

Trait Implementations

impl<T: InspectTask<S>, S> Inspect for TaskControl<T, S>

fn inspect(&self, req: Request<'_>)

Inspects the object.

impl<T: InspectTaskMut<U>, U> InspectMut for TaskControl<T, U>

fn inspect_mut(&mut self, req: Request<'_>)

Inspects the object.