Struct Counter

pub struct Counter(/* private fields */);

A counter with current and maximum tracking, and optional merging behavior.

Implementations

impl Counter

pub fn new() -> Self

Creates a new Counter with zeroed values and StatsMergeMode::None.

Example

let c = rmqtt_utils::Counter::new();

pub fn new_with(c: isize, max: isize, m: StatsMergeMode) -> Self

Creates a new Counter with specified values.

Example

let c = rmqtt_utils::Counter::new_with(5, 10, rmqtt_utils::StatsMergeMode::Sum);

pub fn inc(&self)

Increments current count by 1 and updates max if needed.

Example

let c = rmqtt_utils::Counter::new();
c.inc();

pub fn incs(&self, c: isize)

Increments current count by c and updates max if needed.

Example

let c = rmqtt_utils::Counter::new();
c.incs(5);

pub fn current_inc(&self)

Increments current count by 1 without affecting max.

Example

let c = rmqtt_utils::Counter::new();
c.current_inc();

pub fn current_incs(&self, c: isize)

Increments current count by c without affecting max.

Example

let c = rmqtt_utils::Counter::new();
c.current_incs(3);

pub fn current_set(&self, c: isize)

Sets the current count directly, does not affect max.

Example

let c = rmqtt_utils::Counter::new();
c.current_set(100);

pub fn sets(&self, c: isize)

Sets the current count and possibly updates the max.

Example

let c = rmqtt_utils::Counter::new();
c.sets(20);

pub fn dec(&self)

Decrements current count by 1.

Example

let c = rmqtt_utils::Counter::new();
c.dec();

pub fn decs(&self, c: isize)

Decrements current count by c.

Example

let c = rmqtt_utils::Counter::new();
c.decs(4);

pub fn count_min(&self, count: isize)

Sets current count to the minimum of its current value and count.

Example

let c = rmqtt_utils::Counter::new();
c.count_min(5);

pub fn count_max(&self, count: isize)

Sets current count to the maximum of its current value and count.

Example

let c = rmqtt_utils::Counter::new();
c.count_max(10);

pub fn max_max(&self, max: isize)

Sets max to the maximum of its current value and max.

Example

let c = rmqtt_utils::Counter::new();
c.max_max(50);

pub fn max_min(&self, max: isize)

Sets max to the minimum of its current value and max.

Example

let c = rmqtt_utils::Counter::new();
c.max_min(30);

pub fn count(&self) -> isize

Returns the current count value.

Example

let c = rmqtt_utils::Counter::new();
let v = c.count();

pub fn max(&self) -> isize

Returns the current max value.

Example

let c = rmqtt_utils::Counter::new();
let m = c.max();

pub fn add(&self, other: &Self)

Adds values from another counter.

Example

let a = rmqtt_utils::Counter::new_with(3, 10, rmqtt_utils::StatsMergeMode::None);
let b = rmqtt_utils::Counter::new_with(2, 5, rmqtt_utils::StatsMergeMode::None);
a.add(&b);

pub fn set(&self, other: &Self)

Replaces internal values with those from another counter.

Example

let a = rmqtt_utils::Counter::new();
let b = rmqtt_utils::Counter::new_with(5, 100, rmqtt_utils::StatsMergeMode::None);
a.set(&b);

pub fn merge(&self, other: &Self)

Merges another counter into this one using the configured merge mode.

Example

let a = rmqtt_utils::Counter::new_with(1, 2, rmqtt_utils::StatsMergeMode::Sum);
let b = rmqtt_utils::Counter::new_with(3, 4, rmqtt_utils::StatsMergeMode::Sum);
a.merge(&b);

pub fn to_json(&self) -> Value

Converts the counter to JSON format.

Example

let c = rmqtt_utils::Counter::new();
let json = c.to_json();

Trait Implementations

impl Clone for Counter

fn clone(&self) -> Self

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<'de> Deserialize<'de> for Counter

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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.