Struct vector_core::event::metric::MetricData

pub struct MetricData {
    pub time: MetricTime,
    pub kind: MetricKind,
    pub value: MetricValue,
}

Metric data.

Fields

time: MetricTime

kind: MetricKind

value: MetricValue

Implementations

impl MetricData

pub fn timestamp(&self) -> Option<&DateTime<Utc>>

Gets a reference to the timestamp for this data, if available.

pub fn value(&self) -> &MetricValue

Gets a reference to the value of this data.

pub fn value_mut(&mut self) -> &mut MetricValue

Gets a mutable reference to the value of this data.

pub fn into_absolute(self) -> Self

Consumes this metric, returning it as an absolute metric.

If the metric was already absolute, nothing is changed.

pub fn into_incremental(self) -> Self

Consumes this metric, returning it as an incremental metric.

If the metric was already incremental, nothing is changed.

pub fn from_parts( time: MetricTime, kind: MetricKind, value: MetricValue, ) -> Self

Creates a MetricData directly from the raw components of another MetricData.

pub fn into_parts(self) -> (MetricTime, MetricKind, MetricValue)

Decomposes a MetricData into its individual parts.

pub fn update(&mut self, other: &Self) -> bool

Updates this metric by adding the value from other.

pub fn add(&mut self, other: &Self) -> bool

Adds the data from the other metric to this one.

The other metric must be incremental and contain the same value type as this one.

pub fn subtract(&mut self, other: &Self) -> bool

Subtracts the data from the other metric from this one.

The other metric must contain the same value type as this one.

pub fn zero(&mut self)

Zeroes out the data in this metric.

Trait Implementations

impl AsRef<MetricData> for Metric

fn as_ref(&self) -> &MetricData

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<MetricData> for MetricData

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl ByteSizeOf for MetricData

fn allocated_bytes(&self) -> usize

Returns the allocated bytes of this type

fn size_of(&self) -> usize

Returns the in-memory size of this type

impl Clone for MetricData

fn clone(&self) -> MetricData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Configurable for MetricData

fn referenceable_name() -> Option<&'static str>

Gets the referenceable name of this value, if any.

fn metadata() -> Metadata

Gets the metadata for this value.

fn generate_schema( schema_gen: &RefCell<SchemaGenerator>, ) -> Result<SchemaObject, GenerateError>

Generates the schema for this value.

fn is_optional() -> bool

where Self: Sized,

Whether or not this value is optional.

fn validate_metadata(_metadata: &Metadata) -> Result<(), GenerateError>

where Self: Sized,

Validates the given metadata against this type.

fn as_configurable_ref() -> ConfigurableRef

where Self: Sized + 'static,

Create a new configurable reference table.

impl Debug for MetricData

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MetricData

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for MetricData

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for MetricData

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for MetricData

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToValue for MetricData

fn to_value(&self) -> Value

Convert this value into a serde_json::Value. Must not fail.

impl StructuralPartialEq for MetricData