Struct LogSuppressor 

pub struct LogSuppressor {
    pub(crate) suppressed_count: AtomicUsize,
    pub(crate) rate_limiter: RateLimiter<NotKeyed, InMemoryState, MonotonicClock>,
}

LogSuppressor is a helper to suppress log spamming.

Fields

suppressed_count: AtomicUsize

The number of times the log has been suppressed. Will be returned and cleared when the rate limiter allows next log to be printed.

rate_limiter: RateLimiter<NotKeyed, InMemoryState, MonotonicClock>

Inner rate limiter.

Implementations

impl LogSuppressor

pub fn new( rate_limiter: RateLimiter<NotKeyed, InMemoryState, MonotonicClock>, ) -> Self

pub fn per_second(per_second: u32) -> Self

Create a LogSuppressor that allows per_second logs per second.

pub fn per_minute(per_minute: u32) -> Self

Create a LogSuppressor that allows per_minute logs per minute.

pub fn check(&self) -> Result<Option<NonZeroUsize>, LogSuppressed>

Check if the log should be suppressed. If the log should be suppressed, return Err(LogSuppressed). Otherwise, return Ok(Some(..)) with count of suppressed messages since last check, or Ok(None) if there’s none.

Trait Implementations

impl Default for LogSuppressor

fn default() -> Self

Default rate limiter allows 1 log per second.