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

use std::io::Cursor;

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

use super::{
    GradientFill,
    SolidFill,
};
use crate::{
    reader::driver::xml_read_loop,
    writer::driver::{
        write_end_tag,
        write_start_tag,
    },
};

#[derive(Clone, Default, Debug)]
pub struct BackgroundFillStyleList {
    solid_fill:               Vec<SolidFill>,
    gradient_fill_collection: Vec<GradientFill>,
}

impl BackgroundFillStyleList {
    #[inline]
    #[must_use]
    pub fn solid_fill(&self) -> &[SolidFill] {
        &self.solid_fill
    }

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

    #[inline]
    pub fn solid_fill_mut(&mut self) -> &mut Vec<SolidFill> {
        &mut self.solid_fill
    }

    #[inline]
    #[deprecated(since = "3.0.0", note = "Use solid_fill_mut()")]
    pub fn get_solid_fill_mut(&mut self) -> &mut Vec<SolidFill> {
        self.solid_fill_mut()
    }

    #[inline]
    pub fn set_solid_fill(&mut self, value: impl Into<Vec<SolidFill>>) -> &mut Self {
        self.solid_fill = value.into();
        self
    }

    #[inline]
    pub fn add_solid_fill(&mut self, value: SolidFill) -> &mut Self {
        self.solid_fill.push(value);
        self
    }

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

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

    #[inline]
    pub fn gradient_fill_collectionl_mut(&mut self) -> &mut Vec<GradientFill> {
        &mut self.gradient_fill_collection
    }

    #[inline]
    #[deprecated(since = "3.0.0", note = "Use gradient_fill_collectionl_mut()")]
    pub fn get_gradient_fill_collectionl_mut(&mut self) -> &mut Vec<GradientFill> {
        self.gradient_fill_collectionl_mut()
    }

    #[inline]
    pub fn set_gradient_fill_collection(
        &mut self,
        value: impl Into<Vec<GradientFill>>,
    ) -> &mut Self {
        self.gradient_fill_collection = value.into();
        self
    }

    #[inline]
    pub fn add_gradient_fill_collection(&mut self, value: GradientFill) -> &mut Self {
        self.gradient_fill_collection.push(value);
        self
    }

    pub(crate) fn set_attributes<R: std::io::BufRead>(
        &mut self,
        reader: &mut Reader<R>,
        _e: &BytesStart,
    ) {
        xml_read_loop!(
            reader,
            Event::Start(ref e) => {
                match e.name().into_inner() {
                b"a:solidFill" => {
                    let mut obj = SolidFill::default();
                    obj.set_attributes(reader, e);
                    self.solid_fill.push(obj);
                }
                b"a:gradFill" => {
                    let mut obj = GradientFill::default();
                    obj.set_attributes(reader, e);
                    self.gradient_fill_collection.push(obj);
                }
                _ => (),
                }
            },
            Event::End(ref e) => {
                if  e.name().into_inner() == b"a:bgFillStyleLst" {
                    return
                }
            },
            Event::Eof => panic!("Error: Could not find {} end element", "bgFillStyleLst")
        );
    }

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

        // a:solidFill
        for v in &self.solid_fill {
            v.write_to(writer);
        }

        // a:gradFill
        for v in &self.gradient_fill_collection {
            v.write_to(writer);
        }

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