umya-spreadsheet 3.0.1

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

// xm:sqref
use std::{
    io::Cursor,
    vec,
};

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

use crate::{
    structs::Range,
    writer::driver::{
        write_end_tag,
        write_start_tag,
        write_text_node,
    },
};

#[derive(Default, Debug, Clone)]
pub struct ReferenceSequence {
    value: Vec<Range>,
}
impl ReferenceSequence {
    #[inline]
    #[must_use]
    pub fn value(&self) -> &[Range] {
        &self.value
    }

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

    #[inline]
    pub fn value_mut(&mut self) -> &mut Vec<Range> {
        &mut self.value
    }

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

    #[inline]
    pub fn set_value(&mut self, value: impl Into<Vec<Range>>) -> &mut Self {
        self.value = value.into();
        self
    }

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

    #[inline]
    pub fn remove_value(&mut self) -> &mut Self {
        self.value.clear();
        self
    }

    pub fn set_sqref<S: Into<String>>(&mut self, value: S) -> &mut Self {
        value.into().split(' ').for_each(|range_value| {
            let mut range = Range::default();
            range.set_range(range_value);
            self.value.push(range);
        });
        self
    }

    #[inline]
    #[must_use]
    pub fn sqref(&self) -> String {
        self.value
            .iter()
            .map(Range::range)
            .collect::<Vec<String>>()
            .join(" ")
    }

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

    pub(crate) fn set_attributes<R: std::io::BufRead>(
        &mut self,
        reader: &mut Reader<R>,
        e: &BytesStart,
    ) {
        let mut buf = Vec::new();
        let text = reader.read_text_into(e.name(), &mut buf).unwrap();
        self.set_sqref(crate::helper::utils::unescape_xml_text(&text));
    }

    #[inline]
    pub(crate) fn write_to(&self, writer: &mut Writer<Cursor<Vec<u8>>>) {
        write_start_tag(writer, "xm:sqref", vec![], false);
        write_text_node(writer, self.sqref());
        write_end_tag(writer, "xm:sqref");
    }
}