umya-spreadsheet 3.1.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
185
186
187
188
189
190
191
192

use std::io::Cursor;

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

use crate::{
    reader::driver::get_attribute,
    structs::DoubleValue,
    writer::driver::write_start_tag,
};

#[derive(Clone, Default, Debug)]
pub struct PageMargins {
    left:   DoubleValue,
    right:  DoubleValue,
    top:    DoubleValue,
    bottom: DoubleValue,
    header: DoubleValue,
    footer: DoubleValue,
}
impl PageMargins {
    #[inline]
    #[must_use]
    pub fn left(&self) -> f64 {
        self.left.value()
    }

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

    #[inline]
    pub fn set_left(&mut self, value: f64) -> &mut Self {
        self.left.set_value(value);
        self
    }

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

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

    #[inline]
    pub fn set_right(&mut self, value: f64) -> &mut Self {
        self.right.set_value(value);
        self
    }

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

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

    #[inline]
    pub fn set_top(&mut self, value: f64) -> &mut Self {
        self.top.set_value(value);
        self
    }

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

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

    #[inline]
    pub fn set_bottom(&mut self, value: f64) -> &mut Self {
        self.bottom.set_value(value);
        self
    }

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

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

    #[inline]
    pub fn set_header(&mut self, value: f64) -> &mut Self {
        self.header.set_value(value);
        self
    }

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

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

    #[inline]
    pub fn set_footer(&mut self, value: f64) -> &mut Self {
        self.footer.set_value(value);
        self
    }

    pub(crate) fn set_attributes<R: std::io::BufRead>(
        &mut self,
        _reader: &mut Reader<R>,
        e: &BytesStart,
    ) {
        self.left
            .set_value_string(get_attribute(e, b"left").unwrap());
        self.right
            .set_value_string(get_attribute(e, b"right").unwrap());
        self.top.set_value_string(get_attribute(e, b"top").unwrap());
        self.bottom
            .set_value_string(get_attribute(e, b"bottom").unwrap());
        self.header
            .set_value_string(get_attribute(e, b"header").unwrap());
        self.footer
            .set_value_string(get_attribute(e, b"footer").unwrap());
    }

    pub(crate) fn write_to(&self, writer: &mut Writer<Cursor<Vec<u8>>>) {
        // pageMargins
        // If all margins are zero (common for minimal template sheets),
        // use Excel-compatible defaults to avoid "Line 2, column 0" errors.
        let is_all_zero = self.left.value() == 0.0
            && self.right.value() == 0.0
            && self.top.value() == 0.0
            && self.bottom.value() == 0.0
            && self.header.value() == 0.0
            && self.footer.value() == 0.0;

        let (left, right, top, bottom, header, footer) = if is_all_zero {
            (
                "0.7".to_string(),  "0.7".to_string(),
                "0.75".to_string(), "0.75".to_string(),
                "0.3".to_string(),  "0.3".to_string(),
            )
        } else {
            (
                self.left.value_string(),   self.right.value_string(),
                self.top.value_string(),    self.bottom.value_string(),
                self.header.value_string(), self.footer.value_string(),
            )
        };

        let attributes: crate::structs::AttrCollection = vec![
            ("left", &left).into(),
            ("right", &right).into(),
            ("top", &top).into(),
            ("bottom", &bottom).into(),
            ("header", &header).into(),
            ("footer", &footer).into(),
        ];
        write_start_tag(writer, "pageMargins", attributes, true);
    }
}