Trait glean::traits::StringList
source · [−]pub trait StringList {
fn add<S>(&self, value: S)
where
S: Into<String>;
fn set(&self, value: Vec<String, Global>);
fn test_get_value<'a, S>(&self, ping_name: S) -> Option<Vec<String, Global>>
where
S: Into<Option<&'a str>>;
fn test_get_num_recorded_errors<'a, S>(
&self,
error: ErrorType,
ping_name: S
) -> i32
where
S: Into<Option<&'a str>>;
}
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
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.
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 insend_in_pings
.