Struct TextMetric

pub struct TextMetric { /* private fields */ }

A text metric.

Records a single long Unicode text, used when the limits on String are too low. Text is length-limited to MAX_LENGTH_VALUE bytes.

Implementations

impl TextMetric

pub fn new(meta: CommonMetricData) -> Self

Creates a new text metric.

pub fn set(&self, value: String)

Sets to the specified value.

Arguments

• value - The text to set the metric to.

Notes

Truncates the value (at codepoint boundaries) if it is longer than MAX_LENGTH_VALUE bytes and logs an error.

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

Test-only API (exported for FFI purposes).

Gets the currently stored value as a string.

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 TextMetric

fn clone(&self) -> TextMetric

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextMetric

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

Formats the value using the given formatter.

impl<UT> LiftRef<UT> for TextMetric

type LiftType = Arc<TextMetric>

impl<UT> LowerError<UT> for TextMetric

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for TextMetric

type ReturnType = <Arc<TextMetric> 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 MetricType for TextMetric

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: String) -> 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 TextMetric

const TYPE_ID_META: MetadataBuffer