fmi-rs 0.3.1

Functional Mock-up Interface (FMI) for Rust
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162

#![allow(non_camel_case_types, non_snake_case, non_upper_case_globals)]

use serde::{Deserialize, Serialize};
use std::{fs::File, io::BufReader, path::Path};
use thiserror::Error;

/// Fallback type for `<xs:element ref="Annotations" />`.
#[derive(Debug, Serialize, Deserialize, PartialEq, Clone, Default)]
pub struct Annotations;

#[derive(Debug, Serialize, Deserialize, PartialEq, Clone)]
#[serde(rename_all = "camelCase")]
pub struct BuildDescription {
    #[serde(rename = "@fmiVersion")]
    pub fmiVersion: String,

    #[serde(rename = "BuildConfiguration")]
    pub buildConfigurations: Vec<BuildConfiguration>,

    #[serde(rename = "Annotations")]
    pub annotations: Option<Annotations>,
}

#[derive(Debug, Serialize, Deserialize, PartialEq, Clone)]
#[serde(rename_all = "camelCase")]
pub struct BuildConfiguration {
    #[serde(rename = "@modelIdentifier")]
    pub modelIdentifier: String,

    #[serde(rename = "@platform")]
    pub platform: Option<String>,

    #[serde(rename = "@description")]
    pub description: Option<String>,

    #[serde(rename = "SourceFileSet", default)]
    pub sourceFileSets: Vec<SourceFileSet>,

    #[serde(rename = "Library", default)]
    pub libraries: Vec<Library>,

    #[serde(rename = "Annotations")]
    pub annotations: Option<Annotations>,
}

#[derive(Debug, Serialize, Deserialize, PartialEq, Clone)]
#[serde(rename_all = "camelCase")]
pub struct SourceFileSet {
    #[serde(rename = "@name")]
    pub name: Option<String>,

    #[serde(rename = "@language")]
    pub language: Option<String>,

    #[serde(rename = "@compiler")]
    pub compiler: Option<String>,

    #[serde(rename = "@compilerOptions")]
    pub compilerOptions: Option<String>,

    #[serde(rename = "SourceFile")]
    pub sourceFiles: Vec<SourceFile>,

    #[serde(rename = "PreprocessorDefinition", default)]
    pub preprocessorDefinitions: Vec<PreprocessorDefinition>,

    #[serde(rename = "IncludeDirectory", default)]
    pub includeDirectories: Vec<IncludeDirectory>,

    #[serde(rename = "Annotations")]
    pub annotations: Option<Annotations>,
}

#[derive(Debug, Serialize, Deserialize, PartialEq, Clone)]
#[serde(rename_all = "camelCase")]
pub struct SourceFile {
    #[serde(rename = "@name")]
    pub name: String,

    #[serde(rename = "Annotations")]
    pub annotations: Option<Annotations>,
}

#[derive(Debug, Serialize, Deserialize, PartialEq, Clone)]
#[serde(rename_all = "camelCase")]
pub struct PreprocessorDefinition {
    #[serde(rename = "@name")]
    pub name: String,

    #[serde(rename = "@optional", default)]
    pub optional: bool,

    #[serde(rename = "@value")]
    pub value: Option<String>,

    #[serde(rename = "@description")]
    pub description: Option<String>,

    #[serde(rename = "Option", default)]
    pub options: Vec<PreprocessorOption>,

    #[serde(rename = "Annotations")]
    pub annotations: Option<Annotations>,
}

#[derive(Debug, Serialize, Deserialize, PartialEq, Clone)]
#[serde(rename_all = "camelCase")]
pub struct PreprocessorOption {
    #[serde(rename = "@value")]
    pub value: Option<String>,

    #[serde(rename = "@description")]
    pub description: Option<String>,
}

#[derive(Debug, Serialize, Deserialize, PartialEq, Clone)]
#[serde(rename_all = "camelCase")]
pub struct IncludeDirectory {
    #[serde(rename = "@name")]
    pub name: String,

    #[serde(rename = "Annotations")]
    pub annotations: Option<Annotations>,
}

#[derive(Debug, Serialize, Deserialize, PartialEq, Clone)]
#[serde(rename_all = "camelCase")]
pub struct Library {
    #[serde(rename = "@name")]
    pub name: String,

    #[serde(rename = "@version")]
    pub version: Option<String>,

    #[serde(rename = "@external", default = "bool::default")]
    pub external: bool,

    #[serde(rename = "@description")]
    pub description: Option<String>,

    #[serde(rename = "Annotations")]
    pub annotations: Option<Annotations>,
}

#[derive(Error, Debug)]
pub enum BuildDescriptionError {
    #[error("Failed to open the file")]
    Io(#[from] std::io::Error),

    #[error("Failed to parse the file: {0}")]
    Parse(String),
}

impl BuildDescription {
    pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Self, BuildDescriptionError> {
        let file = File::open(path)?;
        let reader = BufReader::new(file);
        let build_description: BuildDescription = quick_xml::de::from_reader(reader)
            .map_err(|e| BuildDescriptionError::Parse(e.to_string()))?;
        Ok(build_description)
    }
}