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

// headerFooter
use std::io::Cursor;

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

use crate::{
    reader::driver::xml_read_loop,
    structs::{
        OddFooter,
        OddHeader,
    },
    writer::driver::{
        write_end_tag,
        write_start_tag,
    },
};

#[derive(Clone, Default, Debug)]
pub struct HeaderFooter {
    odd_header: OddHeader,
    odd_footer: OddFooter,
}

impl HeaderFooter {
    #[inline]
    #[must_use]
    pub fn odd_header(&self) -> &OddHeader {
        &self.odd_header
    }

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

    #[inline]
    pub fn odd_header_mut(&mut self) -> &mut OddHeader {
        &mut self.odd_header
    }

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

    #[inline]
    pub fn set_odd_header(&mut self, value: OddHeader) -> &mut Self {
        self.odd_header = value;
        self
    }

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

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

    #[inline]
    pub fn odd_footer_mut(&mut self) -> &mut OddFooter {
        &mut self.odd_footer
    }

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

    #[inline]
    pub fn set_odd_footer(&mut self, value: OddFooter) -> &mut Self {
        self.odd_footer = value;
        self
    }

    #[inline]
    pub(crate) fn has_param(&self) -> bool {
        self.odd_header.has_param() || self.odd_footer.has_param()
    }

    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"oddHeader" => {
                    self.odd_header.set_attributes(reader, e);
                }
                b"oddFooter" => {
                    self.odd_footer.set_attributes(reader, e);
                }
                _ => (),
                }
            },
            Event::End(ref e) => {
                if e.name().into_inner() == b"headerFooter" {
                    return
                }
            },
            Event::Eof => panic!("Error: Could not find {} end element", "headerFooter")
        );
    }

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

            // oddHeader
            self.odd_header().write_to(writer);

            // oddFooter
            self.odd_footer().write_to(writer);

            write_end_tag(writer, "headerFooter");
        }
    }
}