tmflib 0.1.37

Interface library for processing TMF payloads
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

//! Intent Characteristic Module
//!

use serde::{Deserialize, Serialize};

/// Represents the value of a characteristic.
/// This enum is used to define the different types of values that a characteristic can have.
#[derive(Clone, Debug, Serialize, Deserialize)]
pub enum Value {
    /// A string array value.
    StringArrayCharacteristic(Vec<String>),
    /// An integer array value.
    IntegerArrayCharacteristic(Vec<i32>),
    /// A string value.
    StringCharacteristic(String),
    /// A float value.
    NumberCharacteristic(f32),
    /// A boolean value.
    BooleanCharacteristic(bool),
    /// A number array value.
    NumberArrayCharacteristic(Vec<f32>),
    /// A boolean value.
    IntegerCharacteristic(i32),
}

/// Represents a characteristic of an intent.
/// This struct is used to define the characteristics of an intent in the TMF921 API.
#[derive(Clone, Default, Debug, Serialize, Deserialize)]
pub struct Characteristic {
    /// An optional unique identifier for the characteristic.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    /// An optional name for the characteristic.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// An optional description of the characteristic.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub value: Option<Value>,
}