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

// worksheetSource
use std::io::Cursor;
use md5::Digest;
use quick_xml::{
    Reader,
    Writer,
    events::BytesStart,
};

use crate::{
    StringValue, reader::driver::get_attribute, set_string_from_xml, structs::Address, writer::driver::write_start_tag
};

#[derive(Clone, Default, Debug)]
pub struct WorksheetSource {
    address: Address,
    name: StringValue,
}

impl WorksheetSource {
    #[must_use]
    pub fn address(&self) -> &Address {
        &self.address
    }

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

    #[deprecated(since = "3.0.0", note = "Use address_mut()")]
    pub fn get_address_mut(&mut self) -> &mut Address {
        self.address_mut()
    }

    pub fn set_address(&mut self, value: Address) -> &mut Self {
        self.address = value;
        self
    }

    #[inline]
    #[must_use]
    pub fn name(&self) -> &str {
        self.name.value_str()
    }

    #[inline]
    pub fn set_name<S: Into<String>>(&mut self, value: S) -> &mut Self {
        self.name.set_value(value);
        self
    }

    /// Create a new worksheet source with sheet name and range
    pub fn new_simple(sheet: impl Into<String>, reference: impl Into<String>) -> Self {
        let mut ws_source = Self::default();
        let mut address = Address::default();
        address.set_sheet_name(sheet);
        address.range_mut().set_range(reference);
        ws_source.set_address(address);
        ws_source
    }

    #[inline]
    pub(crate) fn hash_code(&self) -> String {
        format!(
            "{:x}",
            md5::Md5::digest(format!(
                "{}{}",
                self.address.address(),
                self.name.value_str()
            ))
        )
    }

    pub(crate) fn set_attributes<R: std::io::BufRead>(
        &mut self,
        _reader: &mut Reader<R>,
        e: &BytesStart,
    ) {
        let mut address = Address::default();
        if let Some(v) = get_attribute(e, b"ref") {
            address.range_mut().set_range(v);
        }
        if let Some(v) = get_attribute(e, b"sheet") {
            address.set_sheet_name(v);
        }
        self.set_address(address);
        
        set_string_from_xml!(self, e, name, "name");
    }

    pub(crate) fn write_to(&self, writer: &mut Writer<Cursor<Vec<u8>>>) {
        // worksheetSource
        let mut attributes: crate::structs::AttrCollection = Vec::new();
        let ref_str = self.address.range().range();
        if !ref_str.is_empty() {
            attributes.push(("ref", &ref_str).into());
        }
        if self.address.sheet_name() != "" {
            attributes.push(("sheet", self.address.sheet_name()).into());
        }
        if self.name.has_value() {
            attributes.push(("name", self.name.value_str()).into());
        }
        write_start_tag(writer, "worksheetSource", attributes, true);
    }
}