Struct RepeatedTask

pub struct RepeatedTask<E> {
    name: String,
    cancel_token: CancellationToken,
    inner: Mutex<TaskInner<E>>,
    started: AtomicBool,
    interval: Duration,
    initial_delay: Option<Duration>,
}

Fields

name: String

cancel_token: CancellationToken

inner: Mutex<TaskInner<E>>

started: AtomicBool

interval: Duration

initial_delay: Option<Duration>

Implementations

impl<E: ErrorExt + 'static> RepeatedTask<E>

pub fn new(interval: Duration, task_fn: BoxedTaskFunction<E>) -> Self

Creates a new repeated task. The initial_delay is the delay before the first execution. initial_delay default is None, the initial interval uses the interval. You can use with_initial_delay to set the initial_delay.

pub fn with_initial_delay(self, initial_delay: Option<Duration>) -> Self

pub fn started(&self) -> bool

pub fn start(&self, runtime: Runtime) -> Result<()>

pub async fn stop(&self) -> Result<()>

Trait Implementations

impl<E> Debug for RepeatedTask<E>

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

Formats the value using the given formatter.

impl<E> Display for RepeatedTask<E>

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

Formats the value using the given formatter.

impl<E> Drop for RepeatedTask<E>

fn drop(&mut self)

Executes the destructor for this type.