platz-sdk 0.7.0-beta.3

Platz.io SDK
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

use rust_decimal::Decimal;
use serde::Serialize;
use strum::Display;

#[derive(Debug, Clone, Serialize)]
pub struct PlatzStatus<SN>
where
    SN: Clone + Serialize,
{
    pub status: Status<SN>,
    pub primary_metric: Option<Metric>,
    pub metrics: Option<Vec<Metric>>,
    pub notices: Vec<Notice>,
}

#[derive(Debug, Clone, Serialize, Display)]
#[serde(rename_all = "lowercase")]
pub enum StatusColor {
    #[strum(serialize = "primary")]
    Primary,
    #[strum(serialize = "success")]
    Success,
    #[strum(serialize = "danger")]
    Danger,
    #[strum(serialize = "warning")]
    Warning,
    #[strum(serialize = "secondary")]
    Secondary,
}

#[derive(Debug, Clone, Serialize)]
pub struct Status<SN>
where
    SN: Clone + Serialize,
{
    pub name: SN,
    pub color: StatusColor,
}

#[derive(Debug, Clone, Serialize)]
pub struct Metric {
    pub value: Decimal,
    pub unit: String,
    pub short_description: String,
    pub color: Option<StatusColor>,
}

#[derive(Debug, Clone, Serialize, Display)]
pub enum NoticeLevel {
    Info,
    Warning,
    Danger,
}

#[derive(Debug, Clone, Serialize)]
pub struct Notice {
    pub level: NoticeLevel,
    pub text: String,
}