Struct quanta::Builder

pub struct Builder { /* fields omitted */ }

Builder for creating an upkeep task.

Methods

impl Builder

pub fn new(interval: Duration) -> Builder

Creates a new Builder.

This creates a new internal clock for acquiring the current time. If you have an existing Clock that is already calibrated, it is slightly faster to clone it and construct the builder with new_with_clock to avoid recalibrating.

pub fn new_with_clock(interval: Duration, clock: Clock) -> Builder

Creates a new Builder with the specified Clock instance.

pub fn start(self) -> Result<Handle, Error>

Start the upkeep thread, periodically updating the global coarse time.

If the return value is [Ok(handle)], then the thread was spawned successfully and can be stopped by dropping the returned handle. Otherwise, Err contains the error that was returned when trying to spawn the thread.

Trait Implementations

impl Debug for Builder

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

Formats the value using the given formatter.