Struct Worker 

pub struct Worker<D>
where
    D: Clone,
{
    pub data: D,
    /* private fields */
}

The task worker running this task, stores the users shared data.

This does not allow you to send a shutdown signal or interact with the worker in anyway, it is only used to store user data and the shared stop signal.

Fields

data: D

The users shared data.

Implementations

impl<D> Worker<D>

where D: Clone,

pub fn should_stop(&self) -> bool

Returns true if the running task should cleanup and shutdown.

Examples found in repository

examples/simple.rs (line 14)

async fn task(worker: Worker<Data>) -> Result<(), std::io::Error> {
    loop {
        if worker.should_stop() {
            break;
        }
    }

    Ok(())
}

Trait Implementations

impl<D> Clone for Worker<D>

where D: Clone,

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<D> Debug for Worker<D>

where D: Clone + Debug,

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

Formats the value using the given formatter.