Struct MetricEnvelope 

pub struct MetricEnvelope {
    pub measurements: Vec<MetricMeasurement>,
}

Payload stored in a mark using METRIC_DATA_SCHEMA_NAME.

Fields

measurements: Vec<MetricMeasurement>

Metric recording operations that must be accepted or rejected atomically.

Implementations

impl MetricEnvelope

pub fn builder() -> MetricEnvelopeBuilder

Create a builder for building MetricEnvelope. On the builder, call .measurements(...) to set the values of the fields. Finally, call .build() to create the instance of MetricEnvelope.

impl MetricEnvelope

pub fn validate(&self) -> Result<(), MetricValidationError>

Validate every measurement and their shared instrument descriptors.

Errors

Returns a MetricValidationError when any field violates the Relay metric schema. The complete envelope must be rejected on error.

pub fn validated_measurements( &self, ) -> Result<Vec<ValidatedMetricMeasurement>, MetricValidationError>

Parse this wire envelope into metric measurements safe for export.

Errors

Returns a MetricValidationError when any field violates the Relay metric schema. The complete envelope is rejected on error.

Trait Implementations

impl Clone for MetricEnvelope

fn clone(&self) -> MetricEnvelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MetricEnvelope

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MetricEnvelope

fn deserialize<__D>( __deserializer: __D, ) -> Result<MetricEnvelope, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for MetricEnvelope

fn eq(&self, other: &MetricEnvelope) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for MetricEnvelope

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MetricEnvelope