Enum MaxBwConfig 

#[non_exhaustive]
pub enum MaxBwConfig {
    Set(u64),
    InputBased {
        input_bw: u64,
        overhead: u64,
    },
    Estimated {
        est_input_bw: u64,
        overhead: u64,
    },
    Infinite,
}

Maximum bandwidth configuration mode (specs/rules/srt-livecc.md §5.1.1, lines L3116-L3202).

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Set(u64)

MAXBW_SET (§5.1.1, L3120-3128): MAX_BW set explicitly (bytes/sec). Default: 1 Gbps = 125_000_000 bytes/sec.

InputBased

INPUTBW_SET (§5.1.1, L3130-3146): input rate (bytes/sec) + overhead percentage. MAX_BW = input_bw * (1 + overhead / 100) (L3143).

Fields

input_bw: u64

The sender’s input rate, in bytes per second.

overhead: u64

Overhead percentage (e.g. 25 means 25%).

Estimated

INPUTBW_ESTIMATED (§5.1.1, L3148-3184): measured input rate + overhead. MAX_BW = est_input_bw * (1 + overhead / 100) (L3154).

Unlike MaxBwConfig::InputBased, est_input_bw is updated externally (e.g. the encoder’s measured bitrate). The formula is identical.

Fields

est_input_bw: u64

The estimated sender input rate, in bytes per second.

overhead: u64

Overhead percentage (e.g. 25 means 25%).

Infinite

Unbounded — infinite bandwidth. No packet pacing is applied.

Not a named mode in §5.1.1’s table (L3197-3201), but is the implicit effect when MAX_BW is not set or is unlimited. Represented by a PKT_SND_PERIOD of 0 (send as fast as possible).

Implementations

impl MaxBwConfig

pub fn name(&self) -> &'static str

The §5.1.1 mode name.

pub fn max_bw_bytes_per_sec(&self) -> Option<u64>

Resolve the current MAX_BW value in bytes per second, or None for unbounded (infinite bandwidth).

Per specs/rules/srt-livecc.md §5.1.1:

• MAXBW_SET: returns the explicit value (L3120-3128).
• INPUTBW_SET: returns input_bw * (1 + overhead / 100) (L3143).
• INPUTBW_ESTIMATED: returns est_input_bw * (1 + overhead / 100) (L3154).
• Infinite: returns None.

Trait Implementations

impl Clone for MaxBwConfig

fn clone(&self) -> MaxBwConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MaxBwConfig

impl Debug for MaxBwConfig

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

Formats the value using the given formatter.

impl Default for MaxBwConfig

fn default() -> Self

Default: MaxBwConfig::Set at 1 Gbps (specs/rules/srt-livecc.md §5.1.1, L3122-3123).

impl Display for MaxBwConfig

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

Formats the value using the given formatter.

impl Eq for MaxBwConfig

impl PartialEq for MaxBwConfig

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