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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202

use super::Range;
use crate::{
    helper::{
        address::split_address,
        coordinate::index_from_coordinate,
        utils::compile_regex,
    },
    traits::{
        AdjustmentCoordinate,
        AdjustmentCoordinateWithSheet,
    },
};

#[derive(Clone, Default, Debug)]
pub struct Address {
    sheet_name: Box<str>,
    range:      Range,
}

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

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

    #[inline]
    pub fn set_sheet_name<S: Into<String>>(&mut self, value: S) -> &mut Self {
        self.sheet_name = value.into().into_boxed_str();
        self
    }

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

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

    #[inline]
    pub fn range_mut(&mut self) -> &mut Range {
        &mut self.range
    }

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

    #[inline]
    pub fn set_range(&mut self, value: Range) -> &mut Self {
        self.range = value;
        self
    }

    pub fn set_address<S: Into<String>>(&mut self, value: S) -> &mut Self {
        let org_value = value.into();
        let (sheet_name, range) = split_address(&org_value);
        self.range.set_range(range);
        if !sheet_name.is_empty() {
            self.sheet_name = sheet_name.into();
        }
        self
    }

    #[inline]
    #[must_use]
    pub fn address(&self) -> String {
        self.address_crate(false)
    }

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

    #[inline]
    pub(crate) fn address_ptn2(&self) -> String {
        self.address_crate(true)
    }

    #[inline]
    #[deprecated(since = "3.0.0", note = "Use address_ptn2()")]
    pub(crate) fn get_address_ptn2(&self) -> String {
        self.address_ptn2()
    }

    pub(crate) fn address_crate(&self, is_ptn2: bool) -> String {
        let range = self.range.range();
        if self.sheet_name.is_empty() {
            return range;
        }
        let mut with_space_char = "";
        let mut sheet_name = self.sheet_name.clone();
        if sheet_name.contains(char::is_whitespace) {
            with_space_char = "'";
        }
        if is_ptn2 {
            if sheet_name.contains('!') {
                with_space_char = "'";
            }
            if sheet_name.contains('\'') {
                with_space_char = "'";
                sheet_name = sheet_name.replace('\'', "''").into_boxed_str();
            }
            if sheet_name.contains('"') {
                with_space_char = "'";
            }
            if with_space_char.is_empty()
                && compile_regex!(r"[^0-9a-zA-Z]")
                    .is_match(&sheet_name)
                    .unwrap_or(false)
            {
                with_space_char = "'";
            }
            if with_space_char.is_empty()
                && (None, None, None, None) != index_from_coordinate(&sheet_name)
            {
                with_space_char = "'";
            }
        }
        format!("{with_space_char}{sheet_name}{with_space_char}!{range}")
    }

    #[deprecated(since = "3.0.0", note = "Use address_crate()")]
    pub(crate) fn get_address_crate(&self, is_ptn2: bool) -> String {
        self.address_crate(is_ptn2)
    }
}
impl AdjustmentCoordinateWithSheet for Address {
    #[inline]
    fn adjustment_insert_coordinate_with_sheet(
        &mut self,
        sheet_name: &str,
        root_col_num: u32,
        offset_col_num: u32,
        root_row_num: u32,
        offset_row_num: u32,
    ) {
        if &*self.sheet_name == sheet_name {
            self.range.adjustment_insert_coordinate(
                root_col_num,
                offset_col_num,
                root_row_num,
                offset_row_num,
            );
        }
    }

    #[inline]
    fn adjustment_remove_coordinate_with_sheet(
        &mut self,
        sheet_name: &str,
        root_col_num: u32,
        offset_col_num: u32,
        root_row_num: u32,
        offset_row_num: u32,
    ) {
        if &*self.sheet_name == sheet_name {
            self.range.adjustment_remove_coordinate(
                root_col_num,
                offset_col_num,
                root_row_num,
                offset_row_num,
            );
        }
    }

    #[inline]
    fn is_remove_coordinate_with_sheet(
        &self,
        sheet_name: &str,
        root_col_num: u32,
        offset_col_num: u32,
        root_row_num: u32,
        offset_row_num: u32,
    ) -> bool {
        &*self.sheet_name == sheet_name
            && self.range.is_remove_coordinate(
                root_col_num,
                offset_col_num,
                root_row_num,
                offset_row_num,
            )
    }
}