Enum PeriodicTaskResult 

pub enum PeriodicTaskResult {
    Ok,
    CancelTask,
    TaskReSchedule(PeriodicTaskTime),
}

A result of the task execution which is returned by the user task. See description for the each variant.

Variants

Ok

The task exec was ok. No errors.

CancelTask

Cancels (but not removing) the task due to error or for other reason. By returning this result the timer is unset to stop generating events. But, if since the AbortTask was received and a timer has timed out again the event will be called again. It is not necessary to return the AbortTask again, just return PeriodicTaskResult::Ok exiting imidiatly.

TaskReSchedule(PeriodicTaskTime)

A request to reschedule the task to a new time or interval. The 0 argument should contain new time. The timer mode can be changed.

Trait Implementations

impl Clone for PeriodicTaskResult

fn clone(&self) -> PeriodicTaskResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PeriodicTaskResult

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

Formats the value using the given formatter.

impl PartialEq for PeriodicTaskResult

fn eq(&self, other: &PeriodicTaskResult) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for PeriodicTaskResult

impl Eq for PeriodicTaskResult

impl StructuralPartialEq for PeriodicTaskResult