Struct MonotonicCounter 

pub struct MonotonicCounter { /* private fields */ }

A simple counter that increases by one for each call to next() up to a fixed limit. It never wraps around, reusing a counter value would break the uniqueness required by FrameCounter - instead it is exhausted after the limit was reached, see MonotonicCounter::is_exhausted. Per Default the limit is u64::MAX.

Implementations

impl MonotonicCounter

pub fn new(max_counter: u64) -> Self

Creates a new counter which is exhausted after max_counter was returned.

pub fn with_start_value(start_value: u64, max_counter: u64) -> Self

Creates a new counter with a start value which is exhausted after max_counter was returned.

pub fn current(&self) -> Counter

Returns the current counter value.

pub fn is_exhausted(&self) -> bool

Returns true if all counter values were used up, i.e. the next call to FrameCounter::next will panic.

Trait Implementations

impl Clone for MonotonicCounter

fn clone(&self) -> MonotonicCounter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MonotonicCounter

impl Debug for MonotonicCounter

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

Formats the value using the given formatter.

impl Default for MonotonicCounter

fn default() -> Self

Returns the “default value” for a type.

impl FrameCounter for MonotonicCounter

fn next(&mut self) -> Counter

Panics

If the counter is exhausted, see MonotonicCounter::is_exhausted.