Struct MinRate 

pub struct MinRate {
    pub bytes_per_sec: u32,
    pub window: Duration,
    pub grace: Duration,
    pub check: Duration,
}

A minimum transfer rate, checked per direction while that direction is active.

Examples

use std::time::Duration;
let rate = net_io::MinRate::new(512, Duration::from_secs(10));
assert_eq!(rate.grace, Duration::from_secs(5));
assert!(net_io::MinRate::off().is_off());

Fields

bytes_per_sec: u32

Bytes per second the peer must reach over the window.

window: Duration

The sliding window.

grace: Duration

How long after a direction becomes active the check starts.

check: Duration

How often the rate is checked.

Implementations

impl MinRate

pub const fn off() -> MinRate

No minimum rate.

pub const fn new(bytes_per_sec: u32, window: Duration) -> MinRate

bytes_per_sec over window, after a 5 s grace, checked every second.

pub const fn is_off(&self) -> bool

Whether the rate check is off.

Trait Implementations

impl Clone for MinRate

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 MinRate

impl Debug for MinRate

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

Formats the value using the given formatter.

impl Eq for MinRate

impl PartialEq for MinRate

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MinRate