Struct shadow_rs::utility::counter::Counter

pub struct Counter { /* private fields */ }

The main counter object that maps individual keys to count values.

Implementations

impl Counter

A collection of counters that can store and modify values for a set of keys.

pub fn new() -> Counter

Initializes a new counter map that starts with no keys.

pub fn add_one(&mut self, id: &str) -> i64

Increment the counter value by one for the key given by id. Returns the value of the counter after it was incremented.

pub fn sub_one(&mut self, id: &str) -> i64

Decrement the counter value by one for the key given by id. Returns the value of the counter after it was decremented.

pub fn add_value(&mut self, id: &str, value: i64) -> i64

Increment the counter value by the given value for the key given by id. Returns the value of the counter after it was incremented.

pub fn sub_value(&mut self, id: &str, value: i64) -> i64

Decrement the counter value by the given value for the key given by id. Returns the value of the counter after it was decremented.

pub fn set_value(&mut self, id: &str, value: i64) -> i64

Sets the counter value to the given value for the key given by id. Returns the value of the counter after it was set.

pub fn get_value(&self, id: &str) -> i64

Returns the counter value for the key given by id, or 0 if no operations have been performed on the key.

pub fn add_counter(&mut self, other: &Counter)

Add all values for all keys in other to this counter.

pub fn sub_counter(&mut self, other: &Counter)

Subtract all values for all keys in other from this counter.

Trait Implementations

impl Add for Counter

fn add(self, other: Self) -> Self

Combines two counters by adding all values for all keys of other to self.

type Output = Counter

The resulting type after applying the + operator.

impl Clone for Counter

fn clone(&self) -> Counter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Counter

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

Formats the value using the given formatter.

impl Default for Counter

fn default() -> Self

Returns the “default value” for a type.

impl Display for Counter

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

Returns a string representation of the counter in the form {key1:value1, key2:value2, ..., keyN:valueN} for known keys and values.

impl PartialEq for Counter

fn eq(&self, other: &Counter) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Counter

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for Counter

fn sub(self, other: Self) -> Self

Combines two counters by subtracting all values for all keys of other from self.

type Output = Counter

The resulting type after applying the - operator.

impl Eq for Counter

impl StructuralPartialEq for Counter