Struct PacketRateBudget 

pub struct PacketRateBudget { /* private fields */ }

Caller-reset packet-rate budget.

Implementations

impl PacketRateBudget

pub const fn new(limit: u64) -> Self

Creates a packet-rate budget with limit allowed packets per caller-owned window.

Examples found in repository

examples/service_toolkit.rs (line 13)

fn main() -> Result<(), libaprs_engine::ParseError> {
    let mut engine = Engine::default();
    let mut duplicates = DuplicateWindow::new(128);
    let mut rate = PacketRateBudget::new(100);
    let blocked = SemanticBlocklist::new(&[SemanticFamily::Unsupported, SemanticFamily::Malformed]);

    for packet_bytes in [b"N0CALL>APRS:>service".as_slice()] {
        if rate.try_consume() == RateLimitDecision::Limited {
            continue;
        }
        if duplicates.observe(packet_bytes) == DuplicateDecision::Duplicate {
            continue;
        }

        let packet = parse_packet(packet_bytes)?;
        if blocked.rejects(&packet.aprs_data()) {
            continue;
        }

        let _event = engine.process_event(packet.raw().as_bytes());
    }

    Ok(())
}

pub fn try_consume(&mut self) -> RateLimitDecision

Attempts to consume one packet from the current budget.

Examples found in repository

examples/service_toolkit.rs (line 17)

fn main() -> Result<(), libaprs_engine::ParseError> {
    let mut engine = Engine::default();
    let mut duplicates = DuplicateWindow::new(128);
    let mut rate = PacketRateBudget::new(100);
    let blocked = SemanticBlocklist::new(&[SemanticFamily::Unsupported, SemanticFamily::Malformed]);

    for packet_bytes in [b"N0CALL>APRS:>service".as_slice()] {
        if rate.try_consume() == RateLimitDecision::Limited {
            continue;
        }
        if duplicates.observe(packet_bytes) == DuplicateDecision::Duplicate {
            continue;
        }

        let packet = parse_packet(packet_bytes)?;
        if blocked.rejects(&packet.aprs_data()) {
            continue;
        }

        let _event = engine.process_event(packet.raw().as_bytes());
    }

    Ok(())
}

pub fn reset(&mut self)

Resets the current budget back to the configured limit.

pub const fn limit(&self) -> u64

Returns the configured packet limit.

pub const fn remaining(&self) -> u64

Returns the remaining packet budget in the current caller-owned window.

Trait Implementations

impl Clone for PacketRateBudget

fn clone(&self) -> PacketRateBudget

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PacketRateBudget

impl Debug for PacketRateBudget

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

Formats the value using the given formatter.

impl Eq for PacketRateBudget

impl PartialEq for PacketRateBudget

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PacketRateBudget