Skip to main content

LatencyEstimator

Struct LatencyEstimator 

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

Smoothed endpoint RTT estimates.

The estimator intentionally receives dispatch-to-completion measurements; callers should not feed local queue or pacing delay into it.

Implementations§

Source§

impl LatencyEstimator

Source

pub fn new(config: LatencyEstimatorConfig) -> Self

Creates a latency estimator with the configured initial RTT.

§Panics

Panics when the minimum RTT, initial RTT, EWMA weights, or baseline window is invalid.

Source

pub fn observe(&mut self, sample: Duration)

Observes a dispatch-to-completion RTT using the current clock time.

Use Self::observe_at when deterministic timing is required.

Source

pub fn observe_at(&mut self, sample: Duration, now: Instant)

Observes a dispatch-to-completion RTT at an explicit time.

Samples below LatencyEstimatorConfig::min_rtt are clamped. The explicit time controls rotation of the rolling minimum-RTT window.

Source

pub fn expected_rtt(&self) -> Duration

Returns the long-term RTT used for Little’s Law rate derivation.

Source

pub fn short(&self) -> Duration

Returns the short-term exponentially weighted RTT estimate.

Source

pub fn long(&self) -> Duration

Returns the long-term exponentially weighted RTT estimate.

Source

pub fn baseline(&self) -> Duration

Returns the minimum observed RTT, or the initial estimate before the first successful sample arrives.

Source

pub fn samples(&self) -> u64

Returns the number of RTT samples observed.

Trait Implementations§

Source§

impl Clone for LatencyEstimator

Source§

fn clone(&self) -> LatencyEstimator

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for LatencyEstimator

Source§

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

Formats the value using the given formatter. Read more

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> 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, 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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.