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

use std::io::Cursor;

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

use super::{
    StringValue,
    UInt32Value,
};
use crate::{
    reader::driver::{
        get_attribute,
        set_string_from_xml,
    },
    writer::driver::write_start_tag,
};

#[derive(Clone, Default, Debug)]
pub struct Location {
    reference:        StringValue,
    first_header_row: UInt32Value,
    first_data_row:   UInt32Value,
    first_data_col:   UInt32Value,
}
impl Location {
    #[must_use]
    pub fn reference(&self) -> &str {
        self.reference.value_str()
    }

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

    pub fn set_reference<S: Into<String>>(&mut self, value: S) -> &mut Self {
        self.reference.set_value(value);
        self
    }

    #[must_use]
    pub fn first_header_row(&self) -> u32 {
        self.first_header_row.value()
    }

    #[must_use]
    #[deprecated(since = "3.0.0", note = "Use first_header_row()")]
    pub fn get_first_header_row(&self) -> u32 {
        self.first_header_row()
    }

    pub fn set_first_header_row(&mut self, value: u32) -> &mut Self {
        self.first_header_row.set_value(value);
        self
    }

    #[must_use]
    pub fn first_data_row(&self) -> u32 {
        self.first_data_row.value()
    }

    #[must_use]
    #[deprecated(since = "3.0.0", note = "Use first_data_row()")]
    pub fn get_first_data_row(&self) -> u32 {
        self.first_data_row()
    }

    pub fn set_first_data_row(&mut self, value: u32) -> &mut Self {
        self.first_data_row.set_value(value);
        self
    }

    #[must_use]
    pub fn first_data_col(&self) -> u32 {
        self.first_data_col.value()
    }

    #[must_use]
    #[deprecated(since = "3.0.0", note = "Use first_data_col()")]
    pub fn get_first_data_col(&self) -> u32 {
        self.first_data_col()
    }

    pub fn set_first_data_col(&mut self, value: u32) -> &mut Self {
        self.first_data_col.set_value(value);
        self
    }

    pub(crate) fn set_attributes<R: std::io::BufRead>(
        &mut self,
        _reader: &mut Reader<R>,
        e: &BytesStart,
    ) {
        set_string_from_xml!(self, e, reference, "ref");
        set_string_from_xml!(self, e, first_header_row, "firstHeaderRow");
        set_string_from_xml!(self, e, first_data_row, "firstDataRow");
        set_string_from_xml!(self, e, first_data_col, "firstDataCol");
    }

    #[allow(dead_code)]
    pub(crate) fn write_to(&self, writer: &mut Writer<Cursor<Vec<u8>>>) {
        // location
        write_start_tag(
            writer,
            "location",
            vec![
                ("ref", self.reference.value_str()).into(),
                ("firstHeaderRow", &self.first_header_row.value_string()).into(),
                ("firstDataRow", &self.first_data_row.value_string()).into(),
                ("firstDataCol", &self.first_data_col.value_string()).into(),
            ],
            true,
        );
    }
}