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

use std::fmt;

use super::{
    ColumnReference,
    RowReference,
};
use crate::{
    helper::coordinate::{
        coordinate_from_index_with_lock,
        index_from_coordinate,
    },
    traits::{
        AdjustmentCoordinate,
        AdjustmentValue,
    },
};

#[derive(Clone, Default, Debug, Eq, Ord, PartialEq, PartialOrd)]
pub struct Coordinate {
    column: ColumnReference,
    row:    RowReference,
}

impl fmt::Display for Coordinate {
    #[inline]
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(
            f,
            "{}",
            coordinate_from_index_with_lock(
                self.column.num(),
                self.row.num(),
                self.column.is_lock(),
                self.row.is_lock(),
            )
        )
    }
}

impl Coordinate {
    #[inline]
    #[must_use]
    pub fn col_num(&self) -> u32 {
        self.column.num()
    }

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

    #[inline]
    pub fn set_col_num(&mut self, value: u32) -> &mut Self {
        self.column.set_num(value);
        self
    }

    #[inline]
    pub(crate) fn offset_col_num(&mut self, value: i32) -> &mut Self {
        self.column.offset_num(value);
        self
    }

    #[inline]
    #[must_use]
    pub fn row_num(&self) -> u32 {
        self.row.num()
    }

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

    #[inline]
    pub fn set_row_num(&mut self, value: u32) -> &mut Self {
        self.row.set_num(value);
        self
    }

    #[inline]
    pub(crate) fn offset_row_num(&mut self, value: i32) -> &mut Self {
        self.row.offset_num(value);
        self
    }

    #[inline]
    #[must_use]
    pub fn is_lock_col(&self) -> bool {
        self.column.is_lock()
    }

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

    #[inline]
    pub fn set_is_lock_col(&mut self, value: bool) -> &mut Self {
        self.column.set_is_lock(value);
        self
    }

    #[inline]
    #[must_use]
    pub fn is_lock_row(&self) -> bool {
        self.row.is_lock()
    }

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

    #[inline]
    pub fn set_is_lock_row(&mut self, value: bool) -> &mut Self {
        self.row.set_is_lock(value);
        self
    }

    /// Change coordinates
    /// Formula is not updated.
    #[inline]
    pub fn set_coordinate<S: AsRef<str>>(&mut self, value: S) -> &mut Self {
        let (c, r, cl, rl) = index_from_coordinate(value.as_ref());

        self.column.set_num(c.unwrap());
        self.row.set_num(r.unwrap());
        self.column.set_is_lock(cl.unwrap());
        self.row.set_is_lock(rl.unwrap());

        self
    }

    #[inline]
    #[must_use]
    pub fn get_coordinate(&self) -> String {
        coordinate_from_index_with_lock(
            self.column.num(),
            self.row.num(),
            self.column.is_lock(),
            self.row.is_lock(),
        )
    }
}
impl AdjustmentCoordinate for Coordinate {
    #[inline]
    fn adjustment_insert_coordinate(
        &mut self,
        root_col_num: u32,
        offset_col_num: u32,
        root_row_num: u32,
        offset_row_num: u32,
    ) {
        self.column
            .adjustment_insert_value(root_col_num, offset_col_num);
        self.row
            .adjustment_insert_value(root_row_num, offset_row_num);
    }

    #[inline]
    fn adjustment_remove_coordinate(
        &mut self,
        root_col_num: u32,
        offset_col_num: u32,
        root_row_num: u32,
        offset_row_num: u32,
    ) {
        self.column
            .adjustment_remove_value(root_col_num, offset_col_num);
        self.row
            .adjustment_remove_value(root_row_num, offset_row_num);
    }

    #[inline]
    fn is_remove_coordinate(
        &self,
        root_col_num: u32,
        offset_col_num: u32,
        root_row_num: u32,
        offset_row_num: u32,
    ) -> bool {
        self.column.is_remove_value(root_col_num, offset_col_num)
            || self.row.is_remove_value(root_row_num, offset_row_num)
    }
}