Struct Bitrate

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

A data rate expressed as bits per second(bps).

Internally the value is tracked as a floating point number for accuracy in the presence of repeated calculations that can yield decimal values.

Implementations

impl Bitrate

pub const ZERO: Self = _

A bitrate of zero bit/s.

pub const MAX: Self = _

The maximum bitrate that can be represented.

pub const INFINITY: Self = _

Positive infinity, useful as an invalid value with comparison semantics

pub const NEG_INFINITY: Self = _

Negative infinity, useful as an invalid value with comparison semantics

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

Create a bitrate of some bit per second(bps).

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

Create a bitrate of some Kilobits per second(kbps).

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

Create a bitrate of some Megabits per second(mbps).

pub const fn gbps(gbps: u64) -> Self

Create a bitrate of some Gigabits per second(gbps).

pub fn as_f64(&self) -> f64

The number of bits per second as f64.

pub fn as_u64(&self) -> u64

The number of bits per second rounded upwards as u64.

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

Clamp the value between a min and a max.

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

Return the minimum bitrate between self and other.

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

Return the maximum bitrate between self and other.

pub fn is_valid(&self) -> bool

Whether this bitrate is valid

pub fn as_valid(&self) -> Option<Bitrate>

Turn self into Option<Bitrate> based on its validity

Trait Implementations

impl Add for Bitrate

type Output = Bitrate

The resulting type after applying the + operator.

fn add(self, rhs: Bitrate) -> Self::Output

Performs the + operation.

impl Clone for Bitrate

fn clone(&self) -> Bitrate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Bitrate

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

Formats the value using the given formatter.

impl Display for Bitrate

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

Formats the value using the given formatter.

impl Div<f64> for Bitrate

type Output = Bitrate

The resulting type after applying the / operator.

fn div(self, rhs: f64) -> Self::Output

Performs the / operation.

impl From<f64> for Bitrate

fn from(value: f64) -> Self

Converts to this type from the input type.

impl From<u64> for Bitrate

fn from(value: u64) -> Self

Converts to this type from the input type.

impl Mul<Duration> for Bitrate

type Output = DataSize

The resulting type after applying the * operator.

fn mul(self, rhs: Duration) -> Self::Output

Performs the * operation.

impl Mul<f64> for Bitrate

type Output = Bitrate

The resulting type after applying the * operator.

fn mul(self, rhs: f64) -> Self::Output

Performs the * operation.

impl PartialEq for Bitrate

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Bitrate

fn partial_cmp(&self, other: &Bitrate) -> 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 Sub for Bitrate

type Output = Bitrate

The resulting type after applying the - operator.

fn sub(self, rhs: Bitrate) -> Self::Output

Performs the - operation.

impl Copy for Bitrate

impl StructuralPartialEq for Bitrate