umya-spreadsheet 2.3.3

umya-spreadsheet is a library written in pure Rust to read and write xlsx file.
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
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
use crate::helper::const_str::*;
use crate::reader::driver::*;
use crate::structs::custom_properties::Properties as CustomProperties;
use crate::structs::StringValue;
use crate::structs::Worksheet;
use crate::writer::driver::*;
use quick_xml::events::BytesStart;
use quick_xml::events::Event;
use quick_xml::Reader;
use quick_xml::Writer;
use std::borrow::Cow;
use std::io::Cursor;

#[derive(Clone, Debug)]
pub struct Properties {
    creator: StringValue,
    last_modified_by: StringValue,
    created: StringValue,
    modified: StringValue,
    title: StringValue,
    description: StringValue,
    subject: StringValue,
    keywords: StringValue,
    category: StringValue,
    manager: StringValue,
    company: StringValue,
    revision: StringValue,
    version: StringValue,
    custom_properties: CustomProperties,
}
impl Default for Properties {
    #[inline]
    fn default() -> Self {
        let mut created = StringValue::default();
        let mut modified = StringValue::default();
        created.set_value("2006-09-16T00:00:00Z");
        modified.set_value("2006-09-16T00:00:00Z");
        Self {
            creator: StringValue::default(),
            last_modified_by: StringValue::default(),
            created,
            modified,
            title: StringValue::default(),
            description: StringValue::default(),
            subject: StringValue::default(),
            keywords: StringValue::default(),
            category: StringValue::default(),
            manager: StringValue::default(),
            company: StringValue::default(),
            revision: StringValue::default(),
            version: StringValue::default(),
            custom_properties: CustomProperties::default(),
        }
    }
}
impl Properties {
    #[inline]
    pub fn get_creator(&self) -> &str {
        &self.creator.get_value_str()
    }

    #[inline]
    pub fn set_creator<S: Into<String>>(&mut self, value: S) -> &mut Self {
        self.creator.set_value(value);
        self
    }

    #[inline]
    pub fn get_last_modified_by(&self) -> &str {
        &self.last_modified_by.get_value_str()
    }

    #[inline]
    pub fn set_last_modified_by<S: Into<String>>(&mut self, value: S) -> &mut Self {
        self.last_modified_by.set_value(value);
        self
    }

    #[inline]
    pub fn get_created(&self) -> &str {
        &self.created.get_value_str()
    }

    #[inline]
    pub fn set_created<S: Into<String>>(&mut self, value: S) -> &mut Self {
        self.created.set_value(value);
        self
    }

    #[inline]
    pub fn get_modified(&self) -> &str {
        &self.modified.get_value_str()
    }

    #[inline]
    pub fn set_modified<S: Into<String>>(&mut self, value: S) -> &mut Self {
        self.modified.set_value(value);
        self
    }

    #[inline]
    pub fn get_title(&self) -> &str {
        &self.title.get_value_str()
    }

    #[inline]
    pub fn set_title<S: Into<String>>(&mut self, value: S) -> &mut Self {
        self.title.set_value(value);
        self
    }

    #[inline]
    pub fn get_description(&self) -> &str {
        &self.description.get_value_str()
    }

    #[inline]
    pub fn set_description<S: Into<String>>(&mut self, value: S) -> &mut Self {
        self.description.set_value(value);
        self
    }

    #[inline]
    pub fn get_subject(&self) -> &str {
        &self.subject.get_value_str()
    }

    #[inline]
    pub fn set_subject<S: Into<String>>(&mut self, value: S) -> &mut Self {
        self.subject.set_value(value);
        self
    }

    #[inline]
    pub fn get_keywords(&self) -> &str {
        &self.keywords.get_value_str()
    }

    #[inline]
    pub fn set_keywords<S: Into<String>>(&mut self, value: S) -> &mut Self {
        self.keywords.set_value(value);
        self
    }

    #[inline]
    pub fn get_revision(&self) -> &str {
        &self.revision.get_value_str()
    }

    #[inline]
    pub fn set_revision<S: Into<String>>(&mut self, value: S) -> &mut Self {
        self.revision.set_value(value);
        self
    }

    #[inline]
    pub fn get_category(&self) -> &str {
        &self.category.get_value_str()
    }

    #[inline]
    pub fn set_category<S: Into<String>>(&mut self, value: S) -> &mut Self {
        self.category.set_value(value);
        self
    }

    #[inline]
    pub fn get_version(&self) -> &str {
        &self.version.get_value_str()
    }

    #[inline]
    pub fn set_version<S: Into<String>>(&mut self, value: S) -> &mut Self {
        self.version.set_value(value);
        self
    }

    #[inline]
    pub fn get_manager(&self) -> &str {
        &self.manager.get_value_str()
    }

    #[inline]
    pub fn set_manager<S: Into<String>>(&mut self, value: S) -> &mut Self {
        self.manager.set_value(value);
        self
    }

    #[inline]
    pub fn get_company(&self) -> &str {
        &self.company.get_value_str()
    }

    #[inline]
    pub fn set_company<S: Into<String>>(&mut self, value: S) -> &mut Self {
        self.company.set_value(value);
        self
    }

    #[inline]
    pub fn get_custom_properties(&self) -> &CustomProperties {
        &self.custom_properties
    }

    #[inline]
    pub fn get_custom_properties_mut(&mut self) -> &mut CustomProperties {
        &mut self.custom_properties
    }

    #[inline]
    pub fn set_custom_properties(&mut self, value: CustomProperties) -> &mut Self {
        self.custom_properties = value;
        self
    }

    pub(crate) fn set_attributes_core<R: std::io::BufRead>(
        &mut self,
        reader: &mut Reader<R>,
        _e: &BytesStart,
    ) {
        let mut value: String = String::new();
        xml_read_loop!(
            reader,
            Event::Text(e) => {
                value = e.unescape().unwrap().to_string();
            },
            Event::End(ref e) => match e.name().into_inner() {
                b"dc:title" => {self.set_title(std::mem::take(&mut value));},
                b"dc:subject" => {self.set_subject(std::mem::take(&mut value));},
                b"dc:creator" => {self.set_creator(std::mem::take(&mut value));},
                b"cp:keywords" => {self.set_keywords(std::mem::take(&mut value));},
                b"dc:description" => {self.set_description(std::mem::take(&mut value));},
                b"cp:lastModifiedBy" => {self.set_last_modified_by(std::mem::take(&mut value));},
                b"cp:revision" => {self.set_revision(std::mem::take(&mut value));},
                b"dcterms:created" => {self.set_created(std::mem::take(&mut value));},
                b"dcterms:modified" => {self.set_modified(std::mem::take(&mut value));},
                b"cp:category" => {self.set_category(std::mem::take(&mut value));},
                b"cp:version" => {self.set_version(std::mem::take(&mut value));},
                b"Manager" => {self.set_manager(std::mem::take(&mut value));},
                b"Company" => {self.set_company(std::mem::take(&mut value));},
                _ => {}
            },
            Event::Eof => return,
        );
    }

    pub(crate) fn set_attributes_app<R: std::io::BufRead>(
        &mut self,
        reader: &mut Reader<R>,
        _e: &BytesStart,
    ) {
        let mut value: String = String::new();
        xml_read_loop!(
            reader,
            Event::Start(ref e) => {
                match e.name().into_inner(){
                    b"Manager" => {value = String::new();},
                    b"Company" => {value = String::new();},
                    _ => {}
                }
            },
            Event::Text(e) => {
                value = e.unescape().unwrap().to_string();
            },
            Event::End(ref e) => match e.name().into_inner() {
                b"Manager" => {self.set_manager(std::mem::take(&mut value));}
                b"Company" => {self.set_company(std::mem::take(&mut value));}
                _ =>{}
            },
            Event::Eof => return,
        );
    }

    #[inline]
    pub(crate) fn set_attributes_custom<R: std::io::BufRead>(
        &mut self,
        reader: &mut Reader<R>,
        e: &BytesStart,
    ) {
        let mut obj = CustomProperties::default();
        obj.set_attributes(reader, e);
        self.set_custom_properties(obj);
    }

    pub(crate) fn write_to_core(&self, writer: &mut Writer<Cursor<Vec<u8>>>) {
        // cp:coreProperties
        write_start_tag(
            writer,
            "cp:coreProperties",
            vec![
                ("xmlns:cp", COREPROPS_NS),
                ("xmlns:dc", DCORE_NS),
                ("xmlns:dcterms", DCTERMS_NS),
                ("xmlns:dcmitype", DCMITYPE_NS),
                ("xmlns:xsi", XSI_NS),
            ],
            false,
        );

        // dc:title
        if self.title.has_value() {
            write_start_tag(writer, "dc:title", vec![], false);
            write_text_node(writer, self.title.get_value_str());
            write_end_tag(writer, "dc:title");
        }

        // dc:subject
        if self.subject.has_value() {
            write_start_tag(writer, "dc:subject", vec![], false);
            write_text_node(writer, self.subject.get_value_str());
            write_end_tag(writer, "dc:subject");
        }

        // dc:creator
        if self.creator.has_value() {
            write_start_tag(writer, "dc:creator", vec![], false);
            write_text_node(writer, self.creator.get_value_str());
            write_end_tag(writer, "dc:creator");
        }

        // cp:keywords
        if self.keywords.has_value() {
            write_start_tag(writer, "cp:keywords", vec![], false);
            write_text_node(writer, self.keywords.get_value_str());
            write_end_tag(writer, "cp:keywords");
        }

        // dc:description
        if self.description.has_value() {
            write_start_tag(writer, "dc:description", vec![], false);
            write_text_node(writer, self.description.get_value_str());
            write_end_tag(writer, "dc:description");
        }

        // cp:lastModifiedBy
        if self.last_modified_by.has_value() {
            write_start_tag(writer, "cp:lastModifiedBy", vec![], false);
            write_text_node(writer, self.last_modified_by.get_value_str());
            write_end_tag(writer, "cp:lastModifiedBy");
        }

        // cp:revision
        if self.revision.has_value() {
            write_start_tag(writer, "cp:revision", vec![], false);
            write_text_node(writer, self.revision.get_value_str());
            write_end_tag(writer, "cp:revision");
        }

        // dcterms:created
        if self.created.has_value() {
            write_start_tag(
                writer,
                "dcterms:created",
                vec![("xsi:type", "dcterms:W3CDTF")],
                false,
            );
            write_text_node(writer, self.created.get_value_str());
            write_end_tag(writer, "dcterms:created");
        }

        // dcterms:modified
        if self.modified.has_value() {
            write_start_tag(
                writer,
                "dcterms:modified",
                vec![("xsi:type", "dcterms:W3CDTF")],
                false,
            );
            write_text_node(writer, self.modified.get_value_str());
            write_end_tag(writer, "dcterms:modified");
        }

        // cp:category
        if self.category.has_value() {
            write_start_tag(writer, "cp:category", vec![], false);
            write_text_node(writer, self.category.get_value_str());
            write_end_tag(writer, "cp:category");
        }

        // cp:version
        if self.version.has_value() {
            write_start_tag(writer, "cp:version", vec![], false);
            write_text_node(writer, self.version.get_value_str());
            write_end_tag(writer, "cp:version");
        }

        write_end_tag(writer, "cp:coreProperties");
    }

    pub(crate) fn write_to_app(
        &self,
        writer: &mut Writer<Cursor<Vec<u8>>>,
        work_sheet_collection: &[Worksheet],
    ) {
        let sheet_count_str = work_sheet_collection.len().to_string();

        // Properties
        write_start_tag(
            writer,
            "Properties",
            vec![("xmlns", XPROPS_NS), ("xmlns:vt", VTYPES_NS)],
            false,
        );

        // Application
        write_start_tag(writer, "Application", vec![], false);
        write_text_node(writer, "Microsoft Excel");
        write_end_tag(writer, "Application");

        // DocSecurity
        write_start_tag(writer, "DocSecurity", vec![], false);
        write_text_node(writer, "0");
        write_end_tag(writer, "DocSecurity");

        // ScaleCrop
        write_start_tag(writer, "ScaleCrop", vec![], false);
        write_text_node(writer, "false");
        write_end_tag(writer, "ScaleCrop");

        // HeadingPairs
        write_start_tag(writer, "HeadingPairs", vec![], false);

        // vt:vector
        write_start_tag(
            writer,
            "vt:vector",
            vec![("size", "2"), ("baseType", "variant")],
            false,
        );

        // vt:variant
        write_start_tag(writer, "vt:variant", vec![], false);

        // vt:i4
        write_start_tag(writer, "vt:lpstr", vec![], false);
        write_text_node(writer, "Worksheets");
        write_end_tag(writer, "vt:lpstr");

        write_end_tag(writer, "vt:variant");

        // vt:variant
        write_start_tag(writer, "vt:variant", vec![], false);

        // vt:i4
        write_start_tag(writer, "vt:i4", vec![], false);
        write_text_node(writer, &sheet_count_str);
        write_end_tag(writer, "vt:i4");

        write_end_tag(writer, "vt:variant");

        write_end_tag(writer, "vt:vector");

        write_end_tag(writer, "HeadingPairs");

        // TitlesOfParts
        write_start_tag(writer, "TitlesOfParts", vec![], false);

        // vt:vector
        write_start_tag(
            writer,
            "vt:vector",
            vec![("size", &sheet_count_str), ("baseType", "lpstr")],
            false,
        );

        for workseet in work_sheet_collection {
            // vt:lpstr
            write_start_tag(writer, "vt:lpstr", vec![], false);
            write_text_node(writer, workseet.get_name());
            write_end_tag(writer, "vt:lpstr");
        }

        write_end_tag(writer, "vt:vector");

        write_end_tag(writer, "TitlesOfParts");

        // Manager
        write_start_tag(writer, "Manager", vec![], false);
        write_text_node(writer, self.get_manager());
        write_end_tag(writer, "Manager");

        // Company
        write_start_tag(writer, "Company", vec![], false);
        write_text_node(writer, self.get_company());
        write_end_tag(writer, "Company");

        // LinksUpToDate
        write_start_tag(writer, "LinksUpToDate", vec![], false);
        write_text_node(writer, "false");
        write_end_tag(writer, "LinksUpToDate");

        // SharedDoc
        write_start_tag(writer, "SharedDoc", vec![], false);
        write_text_node(writer, "false");
        write_end_tag(writer, "SharedDoc");

        // HyperlinksChanged
        write_start_tag(writer, "HyperlinksChanged", vec![], false);
        write_text_node(writer, "false");
        write_end_tag(writer, "HyperlinksChanged");

        // AppVersion
        write_start_tag(writer, "AppVersion", vec![], false);
        write_text_node(writer, "14.0300");
        write_end_tag(writer, "AppVersion");

        write_end_tag(writer, "Properties");
    }

    #[inline]
    pub(crate) fn write_to_custom(&self, writer: &mut Writer<Cursor<Vec<u8>>>) {
        self.custom_properties.write_to(writer);
    }
}