Skip to main content

Timer

Struct Timer 

Source
pub struct Timer { /* private fields */ }
Expand description

High-level timer for measuring function execution.

Wraps the low-level cycle counter with calibration and conversion to nanoseconds.

Implementations§

Source§

impl Timer

Source

pub fn new() -> Self

Create a new timer with automatic calibration.

Source

pub fn with_cycles_per_ns(cycles_per_ns: f64) -> Self

Create a timer with a known cycles-per-nanosecond value.

Useful for testing or when calibration has already been done.

Source

pub fn cycles_per_ns(&self) -> f64

Get the calibrated cycles per nanosecond.

Source

pub fn resolution_ns(&self) -> f64

Get the estimated timer resolution in nanoseconds.

On x86_64, this is typically ~0.3-1ns (CPU frequency TSC). On aarch64, this varies by SoC: ~1ns on ARMv8.6+ (Graviton4), ~40ns on Apple Silicon/Ampere Altra, ~18ns on Raspberry Pi 4.

Source

pub fn suggested_iterations(&self, target_resolution_ns: f64) -> usize

Suggest minimum iterations per sample based on timer resolution.

For operations faster than the timer resolution, batching multiple iterations per measurement ensures reliable timing data.

§Arguments
  • target_resolution_ns - Desired effective resolution (default: 10ns)
§Returns

Recommended iterations per sample (minimum 1).

Source

pub fn measure_cycles<F, T>(&self, f: F) -> MeasurementResult
where F: FnOnce() -> T,

Measure the execution time of a function in cycles.

Uses black_box to prevent optimization of the measured function.

§Errors

This implementation always succeeds (register-based timers cannot fail), but returns Result for API consistency with PMU-based timers.

Source

pub fn measure_ns<F, T>(&self, f: F) -> Result<f64, MeasurementError>
where F: FnOnce() -> T,

Measure the execution time of a function in nanoseconds.

§Errors

This implementation always succeeds (register-based timers cannot fail), but returns Result for API consistency with PMU-based timers.

Source

pub fn cycles_to_ns(&self, cycles: u64) -> f64

Convert cycles to nanoseconds using calibrated ratio.

Source

pub fn measure_batched_cycles<F, T>( &self, iterations: usize, f: F, ) -> MeasurementResult
where F: FnMut() -> T,

Measure batched iterations and return per-iteration cycles.

Runs the function iterations times and returns the average cycles per iteration. This is useful when timer resolution is too coarse for single-iteration measurements.

§Errors

This implementation always succeeds (register-based timers cannot fail), but returns Result for API consistency with PMU-based timers.

Source

pub fn measure_batched_ns<F, T>( &self, iterations: usize, f: F, ) -> Result<f64, MeasurementError>
where F: FnMut() -> T,

Measure batched iterations and return per-iteration nanoseconds.

§Errors

This implementation always succeeds (register-based timers cannot fail), but returns Result for API consistency with PMU-based timers.

Trait Implementations§

Source§

impl Clone for Timer

Source§

fn clone(&self) -> Timer

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Timer

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Timer

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl Freeze for Timer

§

impl RefUnwindSafe for Timer

§

impl Send for Timer

§

impl Sync for Timer

§

impl Unpin for Timer

§

impl UnwindSafe for Timer

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> EventData for T
where T: Send + Sync,