Struct s2n_quic_core::recovery::bandwidth::Bandwidth

pub struct Bandwidth { /* private fields */ }

Represents a rate at which data is transferred

While bandwidth is typically thought of as an amount of data over a fixed amount of time (bytes per second, for example), in this case we internally represent bandwidth as the inverse: an amount of time to send a fixed amount of data (nanoseconds per kibibyte or 1024 bytes, in this case). This allows for some of the math operations needed on Bandwidth to avoid division, while reducing the likelihood of panicking due to overflow.

The maximum (non-infinite) value that can be represented is ~1 TB/second.

Implementations

impl Bandwidth

pub const ZERO: Bandwidth = _

pub const INFINITY: Bandwidth = _

pub const fn new(bytes: u64, interval: Duration) -> Self

Constructs a new Bandwidth with the given bytes per interval

pub fn as_bytes_per_second(&self) -> u64

Represents the bandwidth as bytes per second

Trait Implementations

impl Clone for Bandwidth

fn clone(&self) -> Bandwidth

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Bandwidth

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

Formats the value using the given formatter.

impl Default for Bandwidth

fn default() -> Self

Returns the “default value” for a type.

impl Div<Bandwidth> for u64

Divides a count of bytes represented as a u64 by the given Bandwidth

Since Bandwidth is a rate of bytes over a time period, this division results in a Duration being returned, representing how long a path with the given Bandwidth would take to transmit the given number of bytes.

type Output = Duration

The resulting type after applying the / operator.

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

Performs the / operation.

impl Mul<Duration> for Bandwidth

type Output = u64

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Ratio<u64>> for Bandwidth

type Output = Bandwidth

The resulting type after applying the * operator.

fn mul(self, rhs: Ratio<u64>) -> Self::Output

Performs the * operation.

impl Ord for Bandwidth

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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Bandwidth

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Bandwidth

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Bandwidth

impl Eq for Bandwidth

impl StructuralPartialEq for Bandwidth