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

use crate::{
    helper::coordinate::{
        adjustment_insert_coordinate,
        adjustment_remove_coordinate,
        is_remove_coordinate,
    },
    traits::AdjustmentValue,
};

#[derive(Clone, Debug, Eq, Ord, PartialEq, PartialOrd)]
pub struct RowReference {
    num:     u32,
    is_lock: bool,
}

impl Default for RowReference {
    #[inline]
    fn default() -> Self {
        Self {
            num:     1,
            is_lock: false,
        }
    }
}

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

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

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

    #[inline]
    pub(crate) fn offset_num(&mut self, value: i32) -> &mut Self {
        if value > 0 {
            self.plus_num(value.try_into().unwrap());
        }
        if value < 0 {
            self.minus_num((-value).try_into().unwrap());
        }
        self
    }

    #[inline]
    pub(crate) fn plus_num(&mut self, value: u32) -> &mut Self {
        self.num += value;
        self
    }

    #[inline]
    pub(crate) fn minus_num(&mut self, value: u32) -> &mut Self {
        self.num -= value;
        self
    }

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

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

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

    #[inline]
    pub fn set_is_lock_usize(&mut self, value: u32) -> &mut Self {
        self.is_lock = value == 1;
        self
    }

    #[inline]
    #[must_use]
    pub fn coordinate(&self) -> String {
        format!("{}{}", if self.is_lock { "$" } else { "" }, self.num)
    }

    #[inline]
    #[must_use]
    #[deprecated(since = "3.0.0", note = "Use coordinate()")]
    pub fn get_coordinate(&self) -> String {
        self.coordinate()
    }
}
impl AdjustmentValue for RowReference {
    #[inline]
    fn adjustment_insert_value(&mut self, root_num: u32, offset_num: u32) {
        self.num = adjustment_insert_coordinate(self.num, root_num, offset_num);
    }

    #[inline]
    fn adjustment_remove_value(&mut self, root_num: u32, offset_num: u32) {
        self.num = adjustment_remove_coordinate(self.num, root_num, offset_num);
    }

    #[inline]
    fn is_remove_value(&self, root_num: u32, offset_num: u32) -> bool {
        is_remove_coordinate(self.num, root_num, offset_num)
    }
}