BandwidthManager

Struct BandwidthManager 

Source
pub struct BandwidthManager { /* private fields */ }
Expand description

Bandwidth manager for controlling incoming/outgoing data rates.

Implementations§

Source§

impl BandwidthManager

Source

pub fn new( outgoing_bw: u32, incoming_bw: u32, window_duration: Duration, ) -> Self

Creates a new bandwidth manager with specified limits (bytes/sec).

Source

pub fn unlimited() -> Self

Creates an unlimited bandwidth manager (no throttling).

Source

pub fn set_outgoing_bandwidth(&mut self, bytes_per_sec: u32)

Sets the outgoing bandwidth limit in bytes per second.

Source

pub fn set_incoming_bandwidth(&mut self, bytes_per_sec: u32)

Sets the incoming bandwidth limit in bytes per second.

Source

pub fn update_window(&mut self, now: Instant)

Updates the bandwidth window if needed.

Source

pub fn can_send_outgoing(&self, byte_count: usize) -> bool

Checks if sending the given number of bytes is allowed. Returns true if allowed, false if would exceed bandwidth limit.

Source

pub fn record_sent(&mut self, byte_count: usize)

Records that the given number of bytes were sent.

Source

pub fn can_receive_incoming(&self, byte_count: usize) -> bool

Checks if receiving the given number of bytes is allowed.

Source

pub fn record_received(&mut self, byte_count: usize)

Records that the given number of bytes were received.

Source

pub fn outgoing_utilization(&self) -> f32

Returns the current outgoing bandwidth utilization (0.0 to 1.0+).

Source

pub fn incoming_utilization(&self) -> f32

Returns the current incoming bandwidth utilization (0.0 to 1.0+).

Trait Implementations§

Source§

impl Clone for BandwidthManager

Source§

fn clone(&self) -> BandwidthManager

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BandwidthManager

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V