CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased - ReleaseDate

Added

• Support for the wasm32-wasip2 target, alongside continued support for wasm32-wasip1.
• Support for the monotonic clock on Emscripten targets, which use Emscripten's POSIX-compatible monotonic clock. (#120)
• Documentation on System Counter support for AArch64 platforms.

Changed

• Breaking change: mock support -- Mock, IntoNanoseconds, and Clock::mock -- is now gated behind the new mock feature flag. The feature is part of the default feature set, so builds using default features are unaffected, but builds using default-features = false must now enable mock explicitly. Additionally, with_clock becomes a no-op when the feature is disabled. (#118)
• Breaking change: the legacy wasm32-wasi target is no longer supported, as WASI support is now selected based on target_env being either p1 or p2. Use wasm32-wasip1 instead.
• Switched from winapi to windows-sys for querying the monotonic clock on Windows. (#114)
• Replaced once_cell and crossbeam-utils with std::sync::OnceLock and portable-atomic, dropping two dependencies in the process. portable-atomic is used with its fallback feature so that platforms without native 64-bit atomic support continue to work.
• CLOCK_OVERRIDE thread local is now initialized with a const block. (#117)
• MSRV bumped to 1.87, which is the minimum version required to support both WASI preview versions.

Fixed

• Fixed compilation on 32-bit platforms, where timespec could no longer be constructed with struct literal syntax due to private fields. (#121)

0.12.6 - 2025-06-10

Fixed

• Avoid potential divide by zero in calibration loop. (#113)

0.12.5 - 2025-01-01

Fixed

• Fixed an issue with lossy truncation in checked arithemtic methods for Instant. (#110)

0.12.4 - 2024-12-13

Fixed

• Updated WASM support to work in WebWorkers. (#107)

0.12.3 - 2024-03-31

Changed

• Disabled counter support on iOS targets even if AArch64 is present. This is due to an issue where the necessary CPU instruction for reading the counter is not available on iOS.

0.12.2 - 2023-12-31

Fixed

• Fixed an issue with the monotonic clock for macOS/iOS where it would undermeasure time compared to what would be measured by std::time::Instant due to using a clock source that did not account for device sleep. (#97)

0.12.1 - 2023-10-31

Fixed

• Populate global recent time before Upkeep starts. (#95)

0.12.0 - 2023-10-04

Added

• Experimental support for ARM. (#91)

Changed

• Update raw-cpuid to 11.0.

0.11.1 - 2023-05-28

Added

• Added a new method, Clock::delta_as_nanos, for getting the delta between two raw measurements as the whole number of nanoseconds instead of the initial conversion to Duration. (#86)

0.11.0 - 2023-03-24

Added

• Instant::elapsed() has been added. (#82)

Changed

• Instant::duration_since and Instant::sub now saturates to zero. (#82)
• Performance of Instant::now under high contention has been improved. (#82)

0.10.1 - 2022-07-20

Added

• Implement std::error::Error for quanta::Error. (#68)

Changed

• Fixed build issue on x86/x86_64 platforms that did not have SSE.
• Fix scaling factor for window.performance.now() in WASM. (#72)

0.10.0 - 2022-05-18

Changed

• Documentation has been updated to reflect that quanta does not track time across system suspends.
• Fixed a panic in the calibration loop if a certain edge case with TSC measurements is encountered.
• Updated a unit test that was frequently flaky to be more precise.

Removed

• Instant::as_u64 has been removed. As it provided direct access to an value that could fundamentally change from version-to-version, it felt like time to remove that footgun and push users more towards the API that mimics std::time.
• Clock::upkeep has been removed. It doesn't need to exist on Clock directly, as we have had the quanta::set_recent free function for a while now, and was just duplicating that.
• Clock::start and Clock::end have been removed. They saw limited usage and overall just added somewhat needless API clutter given that users who are looking to do ultra-precise timing will either want more control or use another technique such as instruction counting.

0.9.3 - 2021-09-16

Added

• CI tests for MIPS/ARM. (#55)

Changed

• Fixed compilation issue with Mock on MIPS/ARM. (#55)
• Simplified how TSC/RDTSC suppoort is detected, which should avoid some situations where it was assumed to be present, but actually was not. (#57)

0.9.2 - 2021-08-25

Changed

• Pinned crossbeam-utils to v0.8.5 where AtomicCell::fetch_update was introduced to fix, which fixes broken builds where Cargo chooses a version between 0.8.0 and 0.8.5.
• Update raw-cpuid to 10.2 and average to 0.13.

0.9.1 - 2021-08-12

Changed

• Switched from atomic-shim to crossbeam-utils for better cross-platform atomic support. (#52)

0.9.0 - 2021-06-17

Added

• Support for WASM/WASI targets. (#45)

0.8.0 - 2021-06-07

Removed

• Instant::as_unix_duration as it was added in error.
• metrics feature flag as metrics-core is no longer a relevant crate.

0.7.2 - 2021-01-25

Changed

• Bumped dependency on raw-cpuid to 9.0 in order to deal with a RustSec advisory.

0.7.1 - 2021-01-24

Fixed

• Incorrect method visibility for non-SSE2 implementation of Counter. (#38)

0.7.0 - 2021-01-03

Changed

• MSRV bumped to 1.45.0.
• Clock::now takes &self instead of &mut self.
• Fixed a bug where a failure to spawn the upkeep thread would not allow subsequent attempts to spawn the upkeep thread to proceed.

Added

• New methods --Instant::now and Instant::recent for getting the current and recent time, respectively.
• New free function quanta::with_clock for setting an override on the current thread that affects calls made to Instant::now and Instant::recent.
• New free function quanta::set_recent to allow customization of how global recent time is updated.

0.6.5 - 2020-09-16

Changed

• Fixed a bug with not being able to start the upkeep thread at all. (#29)

0.6.4 - 2020-08-27

Added

• Add Instant::as_unix_duration to get the duration of time since the Unix epoch from an Instant.

  Changed

• Remove clocksource from dependencies and tests as it no longer compiles on stable or nightly.

0.6.3 - 2020-08-03

Changed

• Publicly expose Clock::upkeep for advanced use cases.
• Relax constraints around checking for multiple sockets. (#25)

0.6.2 - 2020-07-20

Added

• Add support for MIPS/PowerPC. (#23)

0.6.1 - 2020-07-13

Added

• Publicly expose the Error type returned by Upkeep::start.

0.6.0 - 2020-07-06

This version of quanta was a massive overhaul of man areas of the API and internals, which was done in a single PR: (#19). You can read the PR description for the finer details. All changes below are part of the aforementioned PR.

Changed

• Clock::now now returns a monotonic value in all cases.
• No longer possible to get a negative value from Clock::delta.
• Calibration is no longer a fixed one second loop, and will complete when it detects it has a statistically viable calibration ratio, or when it exceeds 200ms of wall-clock time. In most cases, it should complete in under 10ms.
• Calibration is now shared amongst all Clock instances, running only once when the first Clock is created.

0.5.2 - 2020-05-01

Changed

• Fix the logic to figure out when calibration is required. (#14)

0.5.1 - 2020-04-11

Changed

• Small tweak to the docs.

0.5.0 - 2020-04-11

Changed

• Switch to mach for macOS/iOS as it was deprecated in libc. (#12)
• Switch to core::arch for instrinics, and drop the feature flagged configuration to use it. (#12)
• Switch to criterion for benchmarking. (#12)

0.4.0 - 2020-02-20

Changed

• Differentiate between raw and scaled time by adding a new Instant type. (#10)

0.2.0 - 2019-03-10

Changed

• Fixed support for Windows. It was in a bad way, but actually works correctly now!
• Switched to Azure Pipelines CI + Cirrus CI, including formatting, tests, and benchmarks, for Linux, macOS, Windows, and FreeBSD.

0.1.0 - 2019-01-14

Added

• Initial commit.