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

// i
use std::io::Cursor;

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

use crate::{
    reader::driver::{
        get_attribute,
        set_string_from_xml,
        xml_read_loop,
    },
    structs::{
        EnumValue,
        ItemValues,
        MemberPropertyIndex,
        UInt32Value,
    },
    writer::driver::{
        write_end_tag,
        write_start_tag,
    },
};

#[derive(Clone, Default, Debug)]
pub struct RowItem {
    index:                 UInt32Value,
    item_type:             EnumValue<ItemValues>,
    repeated_item_count:   UInt32Value,
    member_property_index: Option<MemberPropertyIndex>,
}
impl RowItem {
    #[inline]
    #[must_use]
    pub fn index(&self) -> u32 {
        self.index.value()
    }

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

    #[inline]
    pub fn set_index(&mut self, value: u32) -> &mut Self {
        self.index.set_value(value);
        self
    }

    #[inline]
    #[must_use]
    pub fn item_type(&self) -> &ItemValues {
        self.item_type.value()
    }

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

    #[inline]
    pub fn set_item_type(&mut self, value: ItemValues) -> &mut Self {
        self.item_type.set_value(value);
        self
    }

    #[inline]
    #[must_use]
    pub fn repeated_item_count(&self) -> u32 {
        self.repeated_item_count.value()
    }

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

    #[inline]
    pub fn set_repeated_item_count(&mut self, value: u32) -> &mut Self {
        self.repeated_item_count.set_value(value);
        self
    }

    #[inline]
    #[must_use]
    pub fn member_property_index(&self) -> Option<&MemberPropertyIndex> {
        self.member_property_index.as_ref()
    }

    #[inline]
    #[must_use]
    #[deprecated(since = "3.0.0", note = "Use member_property_index()")]
    pub fn get_member_property_index(&self) -> Option<&MemberPropertyIndex> {
        self.member_property_index()
    }

    #[inline]
    pub fn member_property_index_mut(&mut self) -> Option<&mut MemberPropertyIndex> {
        self.member_property_index.as_mut()
    }

    #[inline]
    #[deprecated(since = "3.0.0", note = "Use member_property_index_mut()")]
    pub fn get_member_property_index_mut(&mut self) -> Option<&mut MemberPropertyIndex> {
        self.member_property_index_mut()
    }

    #[inline]
    pub fn set_member_property_index_color(&mut self, value: MemberPropertyIndex) -> &mut Self {
        self.member_property_index = Some(value);
        self
    }

    #[inline]
    pub(crate) fn set_attributes<R: std::io::BufRead>(
        &mut self,
        reader: &mut Reader<R>,
        e: &BytesStart,
        empty_flg: bool,
    ) {
        set_string_from_xml!(self, e, index, "i");
        set_string_from_xml!(self, e, item_type, "t");
        set_string_from_xml!(self, e, repeated_item_count, "r");

        if empty_flg {
            return;
        }

        xml_read_loop!(
            reader,
            Event::Empty(ref e) => {
                if e.name().into_inner() == b"x" {
                    let mut obj = MemberPropertyIndex::default();
                    obj.set_attributes(reader, e);
                    self.set_member_property_index_color(obj);
                }
            },
            Event::End(ref e) => {
                if e.name().into_inner() == b"i" {
                    return
                }
            },
            Event::Eof => panic!("Error: Could not find {} end element", "i")
        );
    }

    #[inline]
    pub(crate) fn write_to(&self, writer: &mut Writer<Cursor<Vec<u8>>>) {
        let empty_flg = self.member_property_index.is_none();
        // i
        let mut attributes: crate::structs::AttrCollection = Vec::new();
        let index_str = self.index.value_string();
        if self.index.has_value() {
            attributes.push(("i", &index_str).into());
        }
        let item_type_str = self.item_type.value_string();
        if self.item_type.has_value() {
            attributes.push(("t", item_type_str).into());
        }
        let repeated_item_count_str = self.repeated_item_count.value_string();
        if self.repeated_item_count.has_value() {
            attributes.push(("r", &repeated_item_count_str).into());
        }
        write_start_tag(writer, "i", attributes, empty_flg);
        if !empty_flg {
            if let Some(v) = &self.member_property_index {
                v.write_to(writer);
            }
            write_end_tag(writer, "i");
        }
    }
}