Skip to main content

PhaseTimer

Struct PhaseTimer 

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

Lightweight sub-phase timer for hot-path instrumentation.

Zero overhead when disabled (all methods are no-ops). When enabled, captures phase boundaries via mark() and emits structured timing via emit().

Implementations§

Source§

impl PhaseTimer

Source

pub fn from_env(env_var: &'static str, label: &'static str) -> Self

Create a timer controlled by an environment variable.

Returns a disabled (zero-cost) timer if the env var is unset or != “1”.

Source

pub fn start(&mut self)

Start a new timing cycle. Call at the top of each iteration.

Source

pub fn mark(&mut self, phase: &'static str)

Mark the end of a named phase. The duration is from the previous mark (or start) to now.

Source

pub fn emit(&self, iteration: u64, batch_size: usize)

Emit timing data if enabled and the iteration matches the emit interval.

Default interval: first 5 iterations, then every 100.

Source

pub fn is_enabled(&self) -> bool

Check if the timer is enabled.

Auto Trait Implementations§

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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.