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
172
173
174

// a:pattFill
use std::io::Cursor;

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

use super::{
    BackgroundColor,
    ForegroundColor,
};
use crate::{
    reader::driver::{
        get_attribute,
        xml_read_loop,
    },
    writer::driver::{
        write_end_tag,
        write_start_tag,
    },
};

#[derive(Clone, Debug)]
pub struct PatternFill {
    preset:           Box<str>,
    foreground_color: ForegroundColor,
    background_color: BackgroundColor,
}

impl Default for PatternFill {
    #[inline]
    fn default() -> Self {
        Self {
            preset:           "pct5".into(),
            foreground_color: ForegroundColor::default(),
            background_color: BackgroundColor::default(),
        }
    }
}

impl PatternFill {
    #[inline]
    #[must_use]
    pub fn preset(&self) -> &str {
        &self.preset
    }

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

    #[inline]
    pub fn set_preset(&mut self, value: String) -> &mut Self {
        self.preset = value.into_boxed_str();
        self
    }

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

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

    #[inline]
    pub fn foreground_color_mut(&mut self) -> &mut ForegroundColor {
        &mut self.foreground_color
    }

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

    #[inline]
    pub fn set_foreground_color(&mut self, value: ForegroundColor) -> &mut Self {
        self.foreground_color = value;
        self
    }

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

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

    #[inline]
    pub fn background_color_mut(&mut self) -> &mut BackgroundColor {
        &mut self.background_color
    }

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

    #[inline]
    pub fn set_background_color(&mut self, value: BackgroundColor) -> &mut Self {
        self.background_color = value;
        self
    }

    pub(crate) fn set_attributes<R: std::io::BufRead>(
        &mut self,
        reader: &mut Reader<R>,
        e: &BytesStart,
    ) {
        if let Some(v) = get_attribute(e, b"prst") {
            self.set_preset(v);
        }

        xml_read_loop!(
            reader,
            Event::Start(ref e) => {
                match e.name().into_inner() {
                    b"a:fgClr" => {
                        self.foreground_color.set_attributes(reader, e);
                    },
                    b"a:bgClr" => {
                        self.background_color.set_attributes(reader, e);
                    },
                    _ => (),
                }
            },
            Event::End(ref e) => {
                if e.name().into_inner() == b"a:pattFill" {
                    return
                }
            },
            Event::Eof => panic!("Error: Could not find {} end element", "a:pattFill")
        );
    }

    pub(crate) fn write_to(&self, writer: &mut Writer<Cursor<Vec<u8>>>) {
        // a:pattFill
        write_start_tag(
            writer,
            "a:pattFill",
            vec![("prst", &self.preset).into()],
            false,
        );

        // a:fgClr
        self.foreground_color.write_to(writer);

        // a:bgClr
        self.background_color.write_to(writer);

        write_end_tag(writer, "a:pattFill");
    }
}