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

// cacheField
use std::io::Cursor;

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

use crate::{
    reader::driver::{
        get_attribute,
        set_string_from_xml,
        xml_read_loop,
    },
    structs::{
        SharedItems,
        StringValue,
        UInt32Value,
    },
    writer::driver::{
        write_end_tag,
        write_start_tag,
    },
};

#[derive(Clone, Default, Debug)]
pub struct CacheField {
    name:             StringValue,
    number_format_id: UInt32Value,
    shared_items:     SharedItems,
}
impl CacheField {
    #[inline]
    #[must_use]
    pub fn name(&self) -> &str {
        self.name.value_str()
    }

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

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

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

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

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

    #[inline]
    #[must_use]
    pub fn shared_items(&self) -> &SharedItems {
        &self.shared_items
    }

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

    #[inline]
    pub fn shared_items_mut(&mut self) -> &mut SharedItems {
        &mut self.shared_items
    }

    #[inline]
    #[deprecated(since = "3.0.0", note = "Use shared_items_mut()")]
    pub fn get_shared_items_mut(&mut self) -> &mut SharedItems {
        self.shared_items_mut()
    }

    #[inline]
    pub fn set_shared_items(&mut self, value: SharedItems) -> &mut Self {
        self.shared_items = value;
        self
    }

    #[inline]
    pub(crate) fn hash_code(&self) -> String {
        format!(
            "{:x}",
            md5::Md5::digest(format!(
                "{}{}{}",
                self.name.value_str(),
                self.number_format_id.value_string(),
                self.shared_items.hash_code(),
            ))
        )
    }

    #[inline]
    pub(crate) fn set_attributes<R: std::io::BufRead>(
        &mut self,
        reader: &mut Reader<R>,
        e: &BytesStart,
    ) {
        set_string_from_xml!(self, e, name, "name");
        set_string_from_xml!(self, e, number_format_id, "numFmtId");

        xml_read_loop!(
            reader,
            Event::Empty(ref e) => {
                if e.name().into_inner() == b"sharedItems" {
                    let mut obj = SharedItems::default();
                    obj.set_attributes(reader, e, true);
                    self.set_shared_items(obj);
                }
            },
            Event::Start(ref e) => {
                if e.name().into_inner() == b"sharedItems" {
                    let mut obj = SharedItems::default();
                    obj.set_attributes(reader, e, false);
                    self.set_shared_items(obj);
                }
            },
            Event::End(ref e) => {
                if e.name().into_inner() == b"cacheField" {
                    return
                }
            },
            Event::Eof => panic!("Error: Could not find {} end element", "cacheField")
        );
    }

    #[inline]
    pub(crate) fn write_to(&self, writer: &mut Writer<Cursor<Vec<u8>>>) {
        // cacheField
        write_start_tag(
            writer,
            "cacheField",
            vec![
                ("name", self.name.value_str()).into(),
                ("numFmtId", &self.number_format_id.value_string()).into(),
            ],
            false,
        );

        // sharedItems
        self.shared_items.write_to(writer);

        write_end_tag(writer, "cacheField");
    }
}