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

// pivotField
use std::io::Cursor;

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

use crate::{
    EnumValue, PivotTableAxisValues, reader::driver::{
        get_attribute,
        set_string_from_xml,
    }, structs::{
        BooleanValue,
        Items,
    }, writer::driver::{write_end_tag, write_start_tag}, xml_read_loop
};

#[derive(Clone, Default, Debug)]
pub struct PivotField {
    data_field: BooleanValue,
    show_all:   BooleanValue,
    items: Items,
    axis: EnumValue<PivotTableAxisValues>,
}
impl PivotField {
    #[inline]
    #[must_use]
    pub fn data_field(&self) -> bool {
        self.data_field.value()
    }

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

    #[inline]
    pub fn set_data_field(&mut self, value: bool) -> &mut Self {
        self.data_field.set_value(value);
        self
    }

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

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

    #[inline]
    pub fn set_show_all(&mut self, value: bool) -> &mut Self {
        self.show_all.set_value(value);
        self
    }

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

    #[inline]
    #[must_use]
    pub fn items_mut(&mut self) -> &mut Items {
        &mut self.items
    }

    #[inline]
    pub fn set_items(&mut self, value: Items) -> &mut Self {
        self.items = value;
        self
    }

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

    #[inline]
    pub fn set_axis(&mut self, value: PivotTableAxisValues) -> &mut Self {
        self.axis.set_value(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, data_field, "dataField");
        set_string_from_xml!(self, e, show_all, "showAll");
        set_string_from_xml!(self, e, axis, "axis");

        if empty_flg {
            return;
        }

        xml_read_loop!(
            reader,
            Event::Start(ref e) => {
                if e.name().into_inner() == b"items" {
                    self.items.set_attributes(reader, e);
                }
            },
            Event::End(ref e) => {
                if e.name().into_inner() == b"pivotField" {
                    return;
                }
            },
            Event::Eof => panic!("Error: Could not find {} end element", "pivotField")
        );
    }

    #[inline]
    #[allow(dead_code)]
    pub(crate) fn write_to(&self, writer: &mut Writer<Cursor<Vec<u8>>>) {
        // pivotField
        let empty_flg = self.items.list().is_empty();
        let mut attributes: crate::structs::AttrCollection = Vec::new();
        if self.data_field.has_value() {
            attributes.push(("dataField", self.data_field.value_string()).into());
        }
        if self.axis.has_value() {
            attributes.push(("axis", self.axis.value_string()).into());
        }
        if self.show_all.has_value() {
            attributes.push(("showAll", self.show_all.value_string()).into());
        }
        write_start_tag(
            writer,
            "pivotField",
            attributes,
            empty_flg,
        );
        if !empty_flg {
            self.items.write_to(writer);
            write_end_tag(writer, "pivotField");
        }
    }
}