Struct CounterMetric

pub struct CounterMetric { /* private fields */ }

A counter metric.

Used to count things. The value can only be incremented, not decremented.

Implementations

impl CounterMetric

pub fn new(meta: CommonMetricData) -> Self

Creates a new counter metric.

pub fn add(&self, amount: i32)

Increases the counter by amount.

Arguments

• amount - The amount to increase by. Should be positive.

Notes

Logs an error if the amount is 0 or negative.

pub fn test_get_value(&self, ping_name: Option<String>) -> Option<i32>

Test-only API (exported for FFI purposes).

Gets the currently stored value as an integer.

This doesn’t clear the stored value.

Arguments

• ping_name - the optional name of the ping to retrieve the metric for. Defaults to the first value in send_in_pings.

Returns

The stored value or None if nothing stored.

pub fn test_get_num_recorded_errors(&self, error: ErrorType) -> i32

Exported for test purposes.

Gets the number of recorded errors for the given metric and error type.

Arguments

• error - The type of error

Returns

The number of errors reported.

Trait Implementations

impl Clone for CounterMetric

fn clone(&self) -> CounterMetric

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CounterMetric

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

Formats the value using the given formatter.

impl<UT> LiftRef<UT> for CounterMetric

type LiftType = Arc<CounterMetric>

impl<UT> LowerError<UT> for CounterMetric

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for CounterMetric

type ReturnType = <Arc<CounterMetric> as LowerReturn<UniFfiTag>>::ReturnType

The type that should be returned by scaffolding functions for this type.

fn lower_return(obj: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl MallocSizeOf for CounterMetric

fn size_of(&self, ops: &mut MallocSizeOfOps) -> usize

Measure the heap usage of all descendant heap-allocated structures, but not the space taken up by the value itself.

impl MetricType for CounterMetric

fn meta(&self) -> &CommonMetricDataInternal

Access the stored metadata

fn with_name(&self, name: String) -> Self

Create a new metric from this with a new name.

fn with_dynamic_label(&self, label: DynamicLabelType) -> Self

Create a new metric from this with a specific label.

fn should_record(&self, glean: &Glean) -> bool

Whether this metric should currently be recorded

impl<UT> TypeId<UT> for CounterMetric

const TYPE_ID_META: MetadataBuffer