Struct TimingUpkeep

pub struct TimingUpkeep { /* private fields */ }

Upkeep handle for the high-performance timing system

Implementations

impl TimingUpkeep

pub fn start(update_interval: Duration) -> Self

Create and start a new timing upkeep thread

This configures the quanta crate’s “recent time” feature, which provides ultra-low-overhead access to a slightly-delayed global time. This is useful for high-performance applications where the cost of time queries is significant.

The upkeep thread updates the global time value at the specified interval, allowing other threads to read it without the overhead of a full time query.

Arguments

• update_interval - How often to update the global time (smaller values provide more accurate time but increase CPU usage)

Returns

A handle to the upkeep thread. The thread runs until this handle is dropped.

pub const fn is_active(&self) -> bool

Check if this upkeep is active

pub fn update_recent_time()

Manually update the global recent time

This is useful if you don’t want to use the upkeep thread but still want to occasionally update the global time.

pub fn now() -> Instant

Get the current time using the most efficient method available

This function uses the ultra-low-overhead recent time if available, falling back to a regular time query if not.

pub fn now_ns() -> u64

Get the current timestamp in nanoseconds

This function uses the ultra-low-overhead recent time if available, falling back to a regular time query if not.

Trait Implementations

impl Debug for TimingUpkeep

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

Formats the value using the given formatter.

impl Drop for TimingUpkeep

fn drop(&mut self)

Executes the destructor for this type.