Struct LogSuppresser

pub struct LogSuppresser {
    suppressed_count: AtomicUsize,
    rate_limiter: RateLimiter<NotKeyed, InMemoryState, MonotonicClock>,
}

LogSuppresser 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 LogSuppresser

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

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 LogSuppresser

fn default() -> Self

Default rate limiter allows 1 log per second.