Skip to main content

PhaseEstimator

Struct PhaseEstimator 

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

Tracks the producer’s arrival cadence from the consumer side.

Implementations§

Source§

impl PhaseEstimator

Source

pub fn new(cfg: PhaseConfig) -> Self

Source

pub fn record(&mut self, now: Instant)

Record an arrival observed at now. O(1); updates the period EWMA, the CV, the sample count, and the engaged state (with hysteresis).

Source

pub fn predict_next(&self) -> Option<Instant>

Predicted timestamp of the next arrival, or None if no period is known yet.

Source

pub fn engaged(&self) -> bool

Whether prediction is currently engaged (regular enough cadence, enough samples).

Source

pub fn period(&self) -> Option<Duration>

Current EWMA period estimate.

Source

pub fn cv(&self) -> f64

Current coefficient-of-variation estimate.

Source

pub fn samples(&self) -> u64

Number of inter-arrivals observed.

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.