Struct Rate 

pub struct Rate(/* private fields */);

A rate, in bits per second.

A newtype rather than a bare integer because everything that meets in an Allocator is the same quantity measured the same way: a congestion controller’s estimate, a track’s reservation, an encoder’s ceiling. One of them reading bytes per second, or kilobits, is off by a factor of eight or a thousand and still typechecks, which is the kind of wrong that reaches production.

Named for what it measures rather than for the module: Session::stats has called this quantity a rate all along (estimated_send_rate).

Implementations

impl Rate

pub const ZERO: Self

No bandwidth at all.

pub const fn from_bps(bps: u64) -> Self

A rate in bits per second, the unit every wire and codec API here uses.

pub const fn from_kbps(kbps: u64) -> Self

A rate in kilobits (1000 bits) per second, saturating.

pub const fn from_mbps(mbps: u64) -> Self

A rate in megabits (1000 kilobits) per second, saturating.

pub const fn as_bps(self) -> u64

This rate in bits per second, for handing to a codec or FFI that wants a plain integer.

pub fn scaled(self, factor: f64) -> Self

This rate scaled by factor, saturating at both ends.

For the fractional arithmetic rate control does (a ramp allowance, a hysteresis band) without spreading as casts across the callers.

pub const fn abs_diff(self, other: Self) -> Self

The absolute difference between two rates.

Trait Implementations

impl Clone for Rate

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Rate

impl Debug for Rate

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

Formats the value using the given formatter.

impl Default for Rate

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Rate

impl Hash for Rate

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Rate

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Rate

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for Rate

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Rate