flux-limiter 0.8.3

A rate limiter based on the Generic Cell Rate Algorithm (GCRA).
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

// src/errors.rs

// error handling for the flux limiter type

// dependencies
use std::error::Error;
use std::fmt;

use crate::clock::ClockError;

/// Error type for FluxLimiter configuration issues.
#[non_exhaustive]
#[derive(Debug)]
pub enum FluxLimiterError {
    InvalidRate,            // for rate <= 0
    InvalidBurst,           // for burst < 0
    ClockError(ClockError), // error variant for issues with the system clock
}

// implement the Display trait for the FluxLimiterError type
impl fmt::Display for FluxLimiterError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            FluxLimiterError::InvalidRate => write!(f, "Rate must be positive"),
            FluxLimiterError::InvalidBurst => write!(f, "Burst must be non-negative"),
            FluxLimiterError::ClockError(err) => {
                write!(f, "Clock error occurred: {}", err)
            }
        }
    }
}

// implement the Error trait for the FluxLimiterError type
impl Error for FluxLimiterError {
    fn source(&self) -> Option<&(dyn Error + 'static)> {
        match self {
            FluxLimiterError::ClockError(err) => Some(err),
            _ => None,
        }
    }
}

// implement From<ClockError> for ergonomic ? conversion
impl From<ClockError> for FluxLimiterError {
    fn from(err: ClockError) -> Self {
        FluxLimiterError::ClockError(err)
    }
}