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

// dataField
use std::io::Cursor;

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

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

#[derive(Clone, Default, Debug)]
pub struct DataField {
    name:        StringValue,
    fie_id:      UInt32Value,
    base_fie_id: Int32Value,
    base_item:   UInt32Value,
    subtotal: UInt32Value,  // Aggregation function: 0=sum, 1=count, 2=average, 3=max, 4=min, 5=product, 7=stdDev, 9=var
}
impl DataField {
    #[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 fie_id(&self) -> u32 {
        self.fie_id.value()
    }

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

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

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

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

    #[inline]
    pub fn set_base_fie_id(&mut self, value: i32) -> &mut Self {
        self.base_fie_id.set_value(value);
        self
    }

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

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

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

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

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

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

    #[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, fie_id, "fld");
        set_string_from_xml!(self, e, base_fie_id, "baseField");
        set_string_from_xml!(self, e, base_item, "baseItem");
        set_string_from_xml!(self, e, subtotal, "subtotal");
    }

    #[inline]
    #[allow(dead_code)]
    pub(crate) fn write_to(&self, writer: &mut Writer<Cursor<Vec<u8>>>) {
        // dataField
        write_start_tag(
            writer,
            "dataField",
            vec![
                ("name", self.name.value_str()).into(),
                ("fld", self.fie_id.value_string().as_str()).into(),
                ("baseField", self.base_fie_id.value_string().as_str()).into(),
                ("baseItem", self.base_item.value_string().as_str()).into(),
                ("subtotal", self.subtotal.value_string().as_str()).into(),
            ],
            true,
        );
    }
}