umya-spreadsheet 3.0.0

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

use std::io::Cursor;

use quick_xml::{
    Reader,
    Writer,
    events::{
        BytesStart,
        Event,
    },
};

use crate::{
    helper::const_str::{
        CUSTOM_PROPS_NS,
        VTYPES_NS,
    },
    reader::driver::xml_read_loop,
    structs::custom_properties::CustomDocumentProperty,
    writer::driver::{
        write_end_tag,
        write_start_tag,
    },
};

#[derive(Default, Debug, Clone)]
pub struct Properties {
    custom_document_property_list: Vec<CustomDocumentProperty>,
}

impl Properties {
    #[inline]
    #[must_use]
    pub fn custom_document_property_list(&self) -> &[CustomDocumentProperty] {
        &self.custom_document_property_list
    }

    #[inline]
    #[must_use]
    #[deprecated(since = "3.0.0", note = "Use custom_document_property_list()")]
    pub fn get_custom_document_property_list(&self) -> &[CustomDocumentProperty] {
        self.custom_document_property_list()
    }

    #[inline]
    pub fn custom_document_property_list_mut(&mut self) -> &mut Vec<CustomDocumentProperty> {
        &mut self.custom_document_property_list
    }

    #[inline]
    #[deprecated(since = "3.0.0", note = "Use custom_document_property_list_mut()")]
    pub fn get_custom_document_property_list_mut(&mut self) -> &mut Vec<CustomDocumentProperty> {
        self.custom_document_property_list_mut()
    }

    #[inline]
    pub fn set_custom_document_property_list(
        &mut self,
        value: impl Into<Vec<CustomDocumentProperty>>,
    ) -> &mut Self {
        self.custom_document_property_list = value.into();
        self
    }

    #[inline]
    pub fn add_custom_document_property_list(
        &mut self,
        value: CustomDocumentProperty,
    ) -> &mut Self {
        self.custom_document_property_list.push(value);
        self
    }

    #[inline]
    pub fn remove_custom_document_property_list(&mut self) -> &mut Self {
        self.custom_document_property_list.clear();
        self
    }

    pub(crate) fn set_attributes<R: std::io::BufRead>(
        &mut self,
        reader: &mut Reader<R>,
        _e: &BytesStart,
    ) {
        xml_read_loop!(
            reader,
            Event::Empty(ref e) => {
                if e.name().into_inner() == b"property" {
                    let mut obj = CustomDocumentProperty::default();
                    obj.set_attributes(reader, e, true);
                    self.add_custom_document_property_list(obj);
                }
            },
            Event::Start(ref e) => {
                if e.name().into_inner() == b"property" {
                    let mut obj = CustomDocumentProperty::default();
                    obj.set_attributes(reader, e, false);
                    self.add_custom_document_property_list(obj);
                }
            },
            Event::End(ref e) => {
                if e.name().into_inner() == b"Properties" {
                    return
                }
            },
            Event::Eof => panic!("Error: Could not find {} end element", "Properties")
        );
    }

    pub(crate) fn write_to(&self, writer: &mut Writer<Cursor<Vec<u8>>>) {
        write_start_tag(
            writer,
            "Properties",
            vec![
                ("xmlns", CUSTOM_PROPS_NS).into(),
                ("xmlns:vt", VTYPES_NS).into(),
            ],
            false,
        );
        let mut pid = 2;
        // `pid` starts from 2 no 0 and is an i32 not usize as provided by enumerate
        #[allow(clippy::explicit_counter_loop)]
        for v in &self.custom_document_property_list {
            v.write_to(writer, pid);
            pid += 1;
        }
        write_end_tag(writer, "Properties");
    }
}