glean_core::traits

Trait StringList

Source 
pub trait StringList {
    // Required methods
    fn add<S: Into<String>>(&self, value: S);
    fn set(&self, value: Vec<String>);
    fn test_get_value<'a, S: Into<Option<&'a str>>>(
        &self,
        ping_name: S,
    ) -> Option<Vec<String>>;
    fn test_get_num_recorded_errors(&self, error: ErrorType) -> i32;
}
Expand description

A description for the StringListMetric type.

When changing this trait, make sure all the operations are implemented in the related type in ../metrics/.

Required Methods§

Source

fn add<S: Into<String>>(&self, value: S)

Adds a new string to the list.

§Arguments
  • value - The string to add.
§Notes

Truncates the value if it is longer than MAX_STRING_LENGTH bytes and logs an error.

Source

fn set(&self, value: Vec<String>)

Sets to a specific list of strings.

§Arguments
  • value - The list of string to set the metric to.
§Notes

If passed an empty list, records an error and returns. Truncates the list if it is longer than MAX_LIST_LENGTH and logs an error. Truncates any value in the list if it is longer than MAX_STRING_LENGTH and logs an error.

Source

fn test_get_value<'a, S: Into<Option<&'a str>>>( &self, ping_name: S, ) -> Option<Vec<String>>

Exported for test purposes.

Gets the currently-stored values.

This doesn’t clear the stored value.

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

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

Exported for test purposes.

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

§Arguments
  • error - The type of error
§Returns

The number of errors recorded.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§