Struct RateHint 

pub struct RateHint {
    pub hint_type: RateHintType,
    pub target_rate_x10: u16,
    pub burst_allowance: u16,
    pub duration_secs: u16,
    pub region_id: Option<u32>,
}

Available on crate feature extensions only.

A dynamic rate hint sent during the session

Fields

hint_type: RateHintType

Type of hint

target_rate_x10: u16

Target rate (updates per second * 10)

burst_allowance: u16

Burst allowance

duration_secs: u16

Suggested duration (0 = indefinite)

region_id: Option<u32>

Region ID (only for Region type hints)

Implementations

impl RateHint

pub fn global(rate: f32, burst: u16, duration: Duration) -> Self

Create a global rate hint

pub fn region(region_id: u32, rate: f32, burst: u16, duration: Duration) -> Self

Create a region-specific rate hint

pub fn target_rate(&self) -> f32

Get target rate as updates per second

pub fn duration(&self) -> Option<Duration>

Get duration (None if indefinite)

pub fn wire_size(&self) -> usize

Wire size

pub fn encode(&self) -> Vec<u8>

Encode to bytes

pub fn decode(data: &[u8]) -> Result<Self, NegotiationError>

Decode from bytes

Trait Implementations

impl Clone for RateHint

fn clone(&self) -> RateHint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RateHint

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

Formats the value using the given formatter.

impl PartialEq for RateHint

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

impl StructuralPartialEq for RateHint