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

// cacheSource
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::{
        EnumValue,
        SourceValues,
        WorksheetSource,
    },
    writer::driver::{
        write_end_tag,
        write_start_tag,
    },
};

#[derive(Clone, Default, Debug)]
pub struct CacheSource {
    r#type:           EnumValue<SourceValues>,
    worksheet_source: Option<WorksheetSource>,
}

impl CacheSource {
    #[inline]
    #[must_use]
    pub fn get_type(&self) -> &SourceValues {
        self.r#type.value()
    }

    #[inline]
    pub fn set_type(&mut self, value: SourceValues) -> &mut Self {
        self.r#type.set_value(value);
        self
    }

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

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

    #[inline]
    pub fn worksheet_source_mut(&mut self) -> Option<&mut WorksheetSource> {
        self.worksheet_source.as_mut()
    }

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

    #[inline]
    pub fn set_worksheet_source_mut(&mut self, value: WorksheetSource) -> &mut Self {
        self.worksheet_source = Some(value);
        self
    }

    /// Create a new worksheet cache source
    #[must_use]
    pub fn new_worksheet(worksheet_source: WorksheetSource) -> Self {
        let mut cache_source = Self::default();
        cache_source.set_type(SourceValues::Worksheet);
        cache_source.set_worksheet_source_mut(worksheet_source);
        cache_source
    }

    #[inline]
    pub(crate) fn hash_code(&self) -> String {
        format!(
            "{:x}",
            md5::Md5::digest(format!(
                "{}{}",
                self.r#type.value_string(),
                match &self.worksheet_source {
                    Some(v) => {
                        v.hash_code()
                    }
                    None => {
                        "None".into()
                    }
                },
            ))
        )
    }

    #[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, r#type, "type");

        if empty_flg {
            return;
        }

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

    #[inline]
    pub(crate) fn write_to(&self, writer: &mut Writer<Cursor<Vec<u8>>>) {
        // cacheSource
        let empty_flg = self.worksheet_source.is_none();
        let attributes: crate::structs::AttrCollection =
            vec![("type", self.r#type.value_string()).into()];

        write_start_tag(writer, "cacheSource", attributes, empty_flg);

        if !empty_flg {
            // worksheetSource
            if let Some(v) = &self.worksheet_source {
                v.write_to(writer);
            }
            write_end_tag(writer, "cacheSource");
        }
    }
}