Struct counters::Counters

pub struct Counters { /* fields omitted */ }

Helper to count events for debugging purposes.

Counters uses internal mutability to allow updating events without requiring unique ownership or mutable countexts.

Methods

impl Counters

pub fn new() -> Self

pub fn with_capacity(cap: usize) -> Self

pub fn event(&self, key: &'static str)

Increment the counter for the provided event key.

pub fn set(&self, key: &'static str, value: u64)

Set the value of the counter for a given event key.

pub fn reset_event(&self, key: &'static str)

Reset the counter for the provided event key to zero.

pub fn reset_events<F: Filter>(&self, filter: F)

Reset some of the counters to zero.

pub fn reset_all(&self)

Reset all counters to zero.

pub fn retain<F: Filter>(&self, filter: F)

Keep some of the counters and throw away the rest.

pub fn get(&self, key: &'static str) -> u64

Get the value of the counter or zero if it does not exist.

pub fn accumulate<F: Filter>(&self, filter: F) -> u64

Return the sum of all counters with keys containing the provided filter.

pub fn print<F: Filter>(&self, filter: F, to: &mut dyn Write) -> Result<()>

Print the counters to an io stream.

pub fn print_to_stdout<F: Filter>(&self, filter: F)

Print the counters to stdout.

pub fn append(&self, other: &Counters)

Moves all the elements of other into self, leaving other empty.

pub fn apply<F: Filter, Cb: FnMut(&'static str, u64) -> u64>(
    &self,
    filter: F,
    callback: Cb
)

Apply a function to all counters matching the provided filter.

Trait Implementations

impl PartialEq<Counters> for Counters

fn eq(&self, _other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

impl Clone for Counters

fn clone(&self) -> Counters

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for Counters

impl Hash for Counters

fn hash<H>(&self, _state: &mut H) where
    H: Hasher, 

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Debug for Counters

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

Formats the value using the given formatter.