Struct BandwidthGovernor 

pub struct BandwidthGovernor { /* private fields */ }

Applies BandwidthPolicy through auto-governors for battery, metered connections, and disk-budget pressure.

use xlb::{BandwidthGovernor, BandwidthPolicy, BwCaps, PeerTier};

let g = BandwidthGovernor::new(
    BandwidthPolicy::default()
        .role(PeerTier::Workstation, BwCaps { up_mbit: 5, down_mbit: 50 }),
);

// AC power: returns configured caps.
assert_eq!(g.effective_caps(PeerTier::Workstation).up_mbit, 5);

// Battery: drops to passive.
g.set_battery(true);
assert_eq!(g.effective_caps(PeerTier::Workstation).up_mbit, 0);

Implementations

impl BandwidthGovernor

pub fn new(policy: BandwidthPolicy) -> Self

Create a governor wrapping policy. Starts in AC / unmetered mode.

pub fn effective_caps(&self, tier: PeerTier) -> BwCaps

Return effective BwCaps for tier.

Returns BwCaps::passive() when on battery or a metered connection; otherwise delegates to the configured BandwidthPolicy.

pub fn is_passive(&self) -> bool

true when any governor is forcing passive mode.

pub fn is_on_battery(&self) -> bool

true when the battery governor has flagged on-battery power.

pub fn is_metered(&self) -> bool

true when the metered-connection governor is active.

pub fn set_battery(&self, on_battery: bool)

Override battery state (for testing or OS-event callbacks).

pub fn set_metered(&self, metered: bool)

Override metered-connection state (for testing or OS-event callbacks).

pub fn probe_os(&self)

Probe the OS for power-source state and update the governor.

Failure is silently ignored — a detection error leaves the governor in its current state. Call this at startup and on relevant OS events.

pub fn has_policy(&self) -> bool

True if the configured policy has any non-passive entries.

Trait Implementations

impl Clone for BandwidthGovernor

fn clone(&self) -> BandwidthGovernor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BandwidthGovernor

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

Formats the value using the given formatter.