fastmetrics 0.7.1

OpenMetrics / Prometheus client library in Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

use crate::error::Result;

/// Trait for encoding unknown numeric values in metrics.
pub trait UnknownValueEncoder {
    /// Encodes a 32-bit signed integer value.
    fn encode_i32(&mut self, value: i32) -> Result<()>;
    /// Encodes a 64-bit signed integer value.
    fn encode_i64(&mut self, value: i64) -> Result<()>;
    /// Encodes a platform-specific signed integer value.
    fn encode_isize(&mut self, value: isize) -> Result<()>;
    /// Encodes a 32-bit unsigned integer value.
    fn encode_u32(&mut self, value: u32) -> Result<()>;

    /// Encodes a 32-bit floating point value.
    fn encode_f32(&mut self, value: f32) -> Result<()>;
    /// Encodes a 64-bit floating point value.
    fn encode_f64(&mut self, value: f64) -> Result<()>;
}

/// Trait for encoding unknown metric values.
pub trait EncodeUnknownValue {
    /// Encodes the value using the provided [`UnknownValueEncoder`].
    fn encode(&self, encoder: &mut dyn UnknownValueEncoder) -> Result<()>;
}

macro_rules! impl_encode_unknown_value {
    ($($value:ty),*) => (
        paste::paste! { $(
            impl EncodeUnknownValue for $value {
                fn encode(&self, encoder: &mut dyn UnknownValueEncoder) -> Result<()> {
                    encoder.[<encode_ $value>](*self)
                }
            }
        )* }
    )
}

impl_encode_unknown_value! { i32, i64, isize, u32, f32, f64 }

/// Trait for encoding gauge numeric values in metrics.
pub trait GaugeValueEncoder {
    /// Encodes a 32-bit signed integer value.
    fn encode_i32(&mut self, value: i32) -> Result<()>;
    /// Encodes a 64-bit signed integer value.
    fn encode_i64(&mut self, value: i64) -> Result<()>;
    /// Encodes a platform-specific signed integer value.
    fn encode_isize(&mut self, value: isize) -> Result<()>;

    /// Encodes a 32-bit floating point value.
    fn encode_f32(&mut self, value: f32) -> Result<()>;
    /// Encodes a 64-bit floating point value.
    fn encode_f64(&mut self, value: f64) -> Result<()>;
}

/// Trait for encoding gauge metric values.
pub trait EncodeGaugeValue {
    /// Encodes the gauge value using the provided [`GaugeValueEncoder`].
    fn encode(&self, encoder: &mut dyn GaugeValueEncoder) -> Result<()>;
}

macro_rules! impl_encode_gauge_value {
    ($($value:ty),*) => (
        paste::paste! { $(
            impl EncodeGaugeValue for $value {
                fn encode(&self, encoder: &mut dyn GaugeValueEncoder) -> Result<()> {
                    encoder.[<encode_ $value>](*self)
                }
            }
        )* }
    )
}

impl_encode_gauge_value! { i32, i64, isize, f32, f64 }

/// Trait for encoding counter numeric values in metrics.
pub trait CounterValueEncoder {
    /// Encodes a 32-bit unsigned integer value.
    fn encode_u32(&mut self, value: u32) -> Result<()>;
    /// Encodes a 64-bit unsigned integer value.
    fn encode_u64(&mut self, value: u64) -> Result<()>;
    /// Encodes a platform-specific unsigned integer value.
    fn encode_usize(&mut self, value: usize) -> Result<()>;

    /// Encodes a 32-bit floating point value.
    fn encode_f32(&mut self, value: f32) -> Result<()>;
    /// Encodes a 64-bit floating point value.
    fn encode_f64(&mut self, value: f64) -> Result<()>;
}

/// Trait for encoding counter metric values.
pub trait EncodeCounterValue {
    /// Encodes the counter value using the provided [`CounterValueEncoder`].
    fn encode(&self, encoder: &mut dyn CounterValueEncoder) -> Result<()>;
}

macro_rules! impl_encode_counter_value {
    ($($value:ty),*) => (
        paste::paste! { $(
            impl EncodeCounterValue for $value {
                fn encode(&self, encoder: &mut dyn CounterValueEncoder) -> Result<()> {
                    encoder.[<encode_ $value>](*self)
                }
            }
        )* }
    )
}

impl_encode_counter_value! { u32, u64, usize, f32, f64 }