excelize-rs 0.1.5

Rust language library for reading and writing Microsoft Excel (XLAM / XLSM / XLSX / XLTM / XLTX) spreadsheets
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
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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239

//! Custom file properties part (`docProps/custom.xml`).
//!
//! Ported from Go `xmlCustom.go`.

use serde::{Deserialize, Serialize};

/// Directly maps the element for the custom file properties part, that
/// represents additional information. The information can be used as metadata
/// for XML.
#[derive(Debug, Default, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename = "Properties")]
pub struct XlsxCustomProperties {
    #[serde(rename = "@xmlns", default)]
    pub xmlns: Option<String>,
    #[serde(rename = "@xmlns:vt", default)]
    pub vt: Option<String>,
    #[serde(rename = "property", default)]
    pub property: Vec<XlsxProperty>,
}

/// Directly maps the element specifies a single custom file property. Custom
/// file property type is defined through child elements in the File Properties
/// Variant Type namespace. Custom file property value can be set by setting the
/// appropriate Variant Type child element value.
#[derive(Debug, Default, Clone, PartialEq, Serialize, Deserialize)]
pub struct XlsxProperty {
    #[serde(rename = "@fmtid", default)]
    pub fmt_id: String,
    #[serde(rename = "@pid", default)]
    pub pid: i64,
    #[serde(rename = "@name", default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    #[serde(
        rename = "@linkTarget",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub link_target: Option<String>,
    #[serde(rename = "vt:vector", default, skip_serializing_if = "Option::is_none")]
    pub vector: Option<String>,
    #[serde(rename = "vt:array", default, skip_serializing_if = "Option::is_none")]
    pub array: Option<String>,
    #[serde(rename = "vt:blob", default, skip_serializing_if = "Option::is_none")]
    pub blob: Option<String>,
    #[serde(rename = "vt:oblob", default, skip_serializing_if = "Option::is_none")]
    pub oblob: Option<String>,
    #[serde(rename = "vt:empty", default, skip_serializing_if = "Option::is_none")]
    pub empty: Option<String>,
    #[serde(rename = "vt:null", default, skip_serializing_if = "Option::is_none")]
    pub null: Option<String>,
    #[serde(rename = "vt:i1", default, skip_serializing_if = "Option::is_none")]
    pub i1: Option<i8>,
    #[serde(rename = "vt:i2", default, skip_serializing_if = "Option::is_none")]
    pub i2: Option<i16>,
    #[serde(rename = "vt:i4", default, skip_serializing_if = "Option::is_none")]
    pub i4: Option<i32>,
    #[serde(rename = "vt:i8", default, skip_serializing_if = "Option::is_none")]
    pub i8: Option<i64>,
    #[serde(rename = "vt:int", default, skip_serializing_if = "Option::is_none")]
    pub int: Option<i64>,
    #[serde(rename = "vt:ui1", default, skip_serializing_if = "Option::is_none")]
    pub ui1: Option<u8>,
    #[serde(rename = "vt:ui2", default, skip_serializing_if = "Option::is_none")]
    pub ui2: Option<u16>,
    #[serde(rename = "vt:ui4", default, skip_serializing_if = "Option::is_none")]
    pub ui4: Option<u32>,
    #[serde(rename = "vt:ui8", default, skip_serializing_if = "Option::is_none")]
    pub ui8: Option<u64>,
    #[serde(rename = "vt:uint", default, skip_serializing_if = "Option::is_none")]
    pub uint: Option<u64>,
    #[serde(rename = "vt:r4", default, skip_serializing_if = "Option::is_none")]
    pub r4: Option<f32>,
    #[serde(rename = "vt:r8", default, skip_serializing_if = "Option::is_none")]
    pub r8: Option<f64>,
    #[serde(
        rename = "vt:decimal",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub decimal: Option<String>,
    #[serde(rename = "vt:lpstr", default, skip_serializing_if = "Option::is_none")]
    pub lpstr: Option<String>,
    #[serde(rename = "vt:lpwstr", default, skip_serializing_if = "Option::is_none")]
    pub lpwstr: Option<String>,
    #[serde(rename = "vt:bstr", default, skip_serializing_if = "Option::is_none")]
    pub bstr: Option<String>,
    #[serde(rename = "vt:date", default, skip_serializing_if = "Option::is_none")]
    pub date: Option<String>,
    #[serde(
        rename = "vt:filetime",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub file_time: Option<String>,
    #[serde(rename = "vt:bool", default, skip_serializing_if = "Option::is_none")]
    pub r#bool: Option<bool>,
    #[serde(rename = "vt:cy", default, skip_serializing_if = "Option::is_none")]
    pub cy: Option<String>,
    #[serde(rename = "vt:error", default, skip_serializing_if = "Option::is_none")]
    pub error: Option<String>,
    #[serde(rename = "vt:stream", default, skip_serializing_if = "Option::is_none")]
    pub stream: Option<String>,
    #[serde(
        rename = "vt:ostream",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub ostream: Option<String>,
    #[serde(
        rename = "vt:storage",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub storage: Option<String>,
    #[serde(
        rename = "vt:ostorage",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub ostorage: Option<String>,
    #[serde(
        rename = "vt:vstream",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub vstream: Option<String>,
    #[serde(rename = "vt:clsid", default, skip_serializing_if = "Option::is_none")]
    pub cls_id: Option<String>,
}

/// Deserialization-only representation of the custom file properties part.
#[derive(Debug, Default, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename = "Properties")]
pub struct DecodeCustomProperties {
    #[serde(rename = "@xmlns", default)]
    pub xmlns: Option<String>,
    #[serde(rename = "@xmlns:vt", default)]
    pub vt: Option<String>,
    #[serde(rename = "property", default)]
    pub property: Vec<DecodeProperty>,
}

/// Deserialization-only representation of a single custom file property.
#[derive(Debug, Default, Clone, PartialEq, Serialize, Deserialize)]
pub struct DecodeProperty {
    #[serde(rename = "@fmtid", default)]
    pub fmt_id: String,
    #[serde(rename = "@pid", default)]
    pub pid: i64,
    #[serde(rename = "@name", default)]
    pub name: Option<String>,
    #[serde(rename = "@linkTarget", default)]
    pub link_target: Option<String>,
    #[serde(rename = "vector", default)]
    pub vector: Option<String>,
    #[serde(rename = "array", default)]
    pub array: Option<String>,
    #[serde(rename = "blob", default)]
    pub blob: Option<String>,
    #[serde(rename = "oblob", default)]
    pub oblob: Option<String>,
    #[serde(rename = "empty", default)]
    pub empty: Option<String>,
    #[serde(rename = "null", default)]
    pub null: Option<String>,
    #[serde(rename = "i1", default)]
    pub i1: Option<i8>,
    #[serde(rename = "i2", default)]
    pub i2: Option<i16>,
    #[serde(rename = "i4", default)]
    pub i4: Option<i32>,
    #[serde(rename = "i8", default)]
    pub i8: Option<i64>,
    #[serde(rename = "int", default)]
    pub int: Option<i64>,
    #[serde(rename = "ui1", default)]
    pub ui1: Option<u8>,
    #[serde(rename = "ui2", default)]
    pub ui2: Option<u16>,
    #[serde(rename = "ui4", default)]
    pub ui4: Option<u32>,
    #[serde(rename = "ui8", default)]
    pub ui8: Option<u64>,
    #[serde(rename = "uint", default)]
    pub uint: Option<u64>,
    #[serde(rename = "r4", default)]
    pub r4: Option<f32>,
    #[serde(rename = "r8", default)]
    pub r8: Option<f64>,
    #[serde(rename = "decimal", default)]
    pub decimal: Option<String>,
    #[serde(rename = "lpstr", default)]
    pub lpstr: Option<String>,
    #[serde(rename = "lpwstr", default)]
    pub lpwstr: Option<String>,
    #[serde(rename = "bstr", default)]
    pub bstr: Option<String>,
    #[serde(rename = "date", default)]
    pub date: Option<String>,
    #[serde(rename = "filetime", default)]
    pub file_time: Option<String>,
    #[serde(rename = "bool", default)]
    pub r#bool: Option<bool>,
    #[serde(rename = "cy", default)]
    pub cy: Option<String>,
    #[serde(rename = "error", default)]
    pub error: Option<String>,
    #[serde(rename = "stream", default)]
    pub stream: Option<String>,
    #[serde(rename = "ostream", default)]
    pub ostream: Option<String>,
    #[serde(rename = "storage", default)]
    pub storage: Option<String>,
    #[serde(rename = "ostorage", default)]
    pub ostorage: Option<String>,
    #[serde(rename = "vstream", default)]
    pub vstream: Option<String>,
    #[serde(rename = "clsid", default)]
    pub cls_id: Option<String>,
}

/// Directly maps the custom property of the workbook. The value date type may be
/// one of the following: int32, float64, string, bool, time.Time, or nil.
#[derive(Debug, Default, Clone, PartialEq, Serialize, Deserialize)]
pub struct CustomProperty {
    pub name: String,
    pub value: Option<CustomPropertyValue>,
}

/// Value types that can be stored in a custom property.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(untagged)]
pub enum CustomPropertyValue {
    Int(i32),
    Float(f64),
    Bool(bool),
    Date(String),
    String(String),
}