pub struct ObjectMetric { /* private fields */ }
Expand description
An object metric.
Record structured data. The value must adhere to a predefined structure and is serialized into JSON.
Implementations§
Source§impl ObjectMetric
impl ObjectMetric
Sourcepub fn new(meta: CommonMetricData) -> Self
pub fn new(meta: CommonMetricData) -> Self
Creates a new object metric.
Sourcepub fn set(&self, value: JsonValue)
pub fn set(&self, value: JsonValue)
Sets to the specified structure.
No additional verification is done. The shape needs to be externally verified.
§Arguments
value
- the value to set.
Sourcepub fn set_string(&self, object: String)
pub fn set_string(&self, object: String)
Sets to the specified structure.
Parses the passed JSON string. If it can’t be parsed into a valid object it records an invalid value error.
Note: This does not check the structure. This needs to be done by the wrapper.
§Arguments
object
- JSON representation of the object to set.
Sourcepub fn record_schema_error(&self)
pub fn record_schema_error(&self)
Record an InvalidValue
error for this metric.
Only to be used by the RLB.
Sourcepub fn test_get_value(&self, ping_name: Option<String>) -> Option<JsonValue>
pub fn test_get_value(&self, ping_name: Option<String>) -> Option<JsonValue>
Test-only API (exported for FFI purposes).
Gets the currently stored value as JSON.
This doesn’t clear the stored value.
Sourcepub fn test_get_num_recorded_errors(&self, error: ErrorType) -> i32
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 errorping_name
- represents the optional name of the ping to retrieve the metric for. inner to the first value insend_in_pings
.
§Returns
The number of errors reported.
Trait Implementations§
Source§impl Clone for ObjectMetric
impl Clone for ObjectMetric
Source§fn clone(&self) -> ObjectMetric
fn clone(&self) -> ObjectMetric
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read more