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
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

//! Intent Module

use super::characteristic::Characteristic;
use super::expression::IntentExpression;
use super::MOD_PATH;
use crate::common::attachment::AttachmentRefOrValue;
use crate::common::related_party::RelatedParty;
use crate::common::tmf_error::TMFError;
use crate::{DateTime, HasAttachment, HasDescription, HasId, HasName, HasRelatedParty, TimePeriod};
use serde::{Deserialize, Serialize};
use tmflib_derive::{HasAttachment, HasDescription, HasId, HasName, HasRelatedParty};

const CLASS_PATH: &str = "intent";

/// Represents an Intent with various attributes such as id, href, name, description, version, status, and valid_for period.
///
/// # Fields
///
/// * `id` - An optional unique identifier for the intent.
/// * `href` - An optional hyperlink reference to the intent.
/// * `name` - An optional name for the intent.
/// * `description` - An optional description of the intent.
/// * `version` - The version of the intent.
/// * `status` - The current status of the intent.
/// * `valid_for` - An optional time period during which the intent is valid.
#[derive(
    Clone,
    Debug,
    Default,
    Deserialize,
    Serialize,
    HasId,
    HasName,
    HasDescription,
    HasAttachment,
    HasRelatedParty,
)]
#[serde(rename_all = "camelCase")]
pub struct Intent {
    /// An optional unique identifier for the intent.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    /// An optional hyperlink reference to the intent.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub href: Option<String>,
    /// An optional name for the intent.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// An optional description of the intent.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    /// The current status of the intent.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub status: Option<String>,
    /// The date and time when the status was last changed.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub status_change_date: Option<DateTime>,
    /// An optional time period during which the intent is valid.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub valid_for: Option<TimePeriod>,
    /// The version of the intent.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub version: Option<String>,
    /// An optional list of characteristics associated with the intent.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub characteristic: Option<Vec<Characteristic>>,
    /// An optional expressions associated with the intent.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub expression: Option<IntentExpression>,
    /// An optional list of attachments associated with the intent.
    #[serde(skip_serializing_if = "Option::is_none")]
    attachment: Option<Vec<AttachmentRefOrValue>>,
    /// An optional list of related parties associated with the intent.
    #[serde(skip_serializing_if = "Option::is_none")]
    related_party: Option<Vec<RelatedParty>>,
}