Struct DataRate 

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

A data rate quantity, stored internally in bits per second (bps).

Construction

let rate = DataRate::from_mbps(100.0);

Implementations

impl DataRate

pub const fn from_bps(val: f64) -> Self

Create from bits per second (canonical unit).

pub const fn from_kbps(val: f64) -> Self

Create from kilobits per second. 1 kbps = 1e3 bps.

pub const fn from_mbps(val: f64) -> Self

Create from megabits per second. 1 Mbps = 1e6 bps.

pub const fn from_gbps(val: f64) -> Self

Create from gigabits per second. 1 Gbps = 1e9 bps.

pub const fn from_bytes_ps(val: f64) -> Self

Create from bytes per second. 1 B/s = 8 bps.

pub const fn from_kbytes_ps(val: f64) -> Self

Create from kilobytes per second. 1 KB/s = 8e3 bps.

pub const fn from_mbytes_ps(val: f64) -> Self

Create from megabytes per second. 1 MB/s = 8e6 bps.

pub const fn from_gbytes_ps(val: f64) -> Self

Create from gigabytes per second. 1 GB/s = 8e9 bps.

pub const fn in_bps(self) -> f64

Get value in bits per second.

pub const fn in_kbps(self) -> f64

Get value in kilobits per second.

pub const fn in_mbps(self) -> f64

Get value in megabits per second.

pub const fn in_gbps(self) -> f64

Get value in gigabits per second.

pub const fn in_bytes_ps(self) -> f64

Get value in bytes per second.

pub const fn in_kbytes_ps(self) -> f64

Get value in kilobytes per second.

pub const fn in_mbytes_ps(self) -> f64

Get value in megabytes per second.

pub const fn in_gbytes_ps(self) -> f64

Get value in gigabytes per second.

pub fn in_unit(self, unit: DataRateUnit) -> f64

Get value in the specified DataRateUnit.

pub fn display_as(self, unit: DataRateUnit) -> DisplayWithUnit

Return a display wrapper that formats this data rate in the given unit.

pub fn abs(self) -> Self

Return the absolute value of this data rate.

Trait Implementations

impl Add for DataRate

type Output = DataRate

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for DataRate

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for DataRate

fn clone(&self) -> DataRate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DataRate

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

Formats the value using the given formatter.

impl Default for DataRate

fn default() -> DataRate

Returns the “default value” for a type.

impl Display for DataRate

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

Formats the value using the given formatter.

impl Div<f64> for DataRate

type Output = DataRate

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div for DataRate

type Output = f64

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<f64> for DataRate

fn div_assign(&mut self, rhs: f64)

Performs the /= operation.

impl Mul<DataRate> for f64

type Output = DataRate

The resulting type after applying the * operator.

fn mul(self, rhs: DataRate) -> DataRate

Performs the * operation.

impl Mul<f64> for DataRate

type Output = DataRate

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<f64> for DataRate

fn mul_assign(&mut self, rhs: f64)

Performs the *= operation.

impl Neg for DataRate

type Output = DataRate

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq for DataRate

fn eq(&self, other: &DataRate) -> 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 DataRate

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

type Output = DataRate

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for DataRate

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Sum for DataRate

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl Copy for DataRate

impl StructuralPartialEq for DataRate