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

// alignment
use std::io::Cursor;

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

use super::{
    BooleanValue,
    EnumValue,
    HorizontalAlignmentValues,
    UInt32Value,
    VerticalAlignmentValues,
};
use crate::{
    reader::driver::{
        get_attribute,
        set_string_from_xml,
    },
    writer::driver::write_start_tag,
};

#[derive(Default, Clone, Debug, Eq, Ord, PartialEq, PartialOrd)]
pub struct Alignment {
    horizontal:    EnumValue<HorizontalAlignmentValues>,
    vertical:      EnumValue<VerticalAlignmentValues>,
    wrap_text:     BooleanValue,
    text_rotation: UInt32Value,
}

impl Alignment {
    #[inline]
    #[must_use]
    pub fn horizontal(&self) -> &HorizontalAlignmentValues {
        self.horizontal.value()
    }

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

    #[inline]
    pub fn set_horizontal(&mut self, value: HorizontalAlignmentValues) {
        self.horizontal.set_value(value);
    }

    #[inline]
    #[must_use]
    pub fn vertical(&self) -> &VerticalAlignmentValues {
        self.vertical.value()
    }

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

    #[inline]
    pub fn set_vertical(&mut self, value: VerticalAlignmentValues) {
        self.vertical.set_value(value);
    }

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

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

    #[inline]
    pub fn set_wrap_text(&mut self, value: bool) {
        self.wrap_text.set_value(value);
    }

    #[inline]
    #[must_use]
    pub fn text_rotation(&self) -> u32 {
        self.text_rotation.value()
    }

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

    #[inline]
    pub fn set_text_rotation(&mut self, value: u32) {
        self.text_rotation.set_value(value);
    }

    pub(crate) fn hash_code(&self) -> String {
        format!(
            "{:x}",
            md5::Md5::digest(format!(
                "{}{}{}{}",
                self.horizontal.hash_string(),
                self.vertical.hash_string(),
                self.wrap_text.hash_string(),
                self.text_rotation.hash_string(),
            ))
        )
    }

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

    #[inline]
    pub(crate) fn set_attributes<R: std::io::BufRead>(
        &mut self,
        _reader: &mut Reader<R>,
        e: &BytesStart,
    ) {
        set_string_from_xml!(self, e, horizontal, "horizontal");
        set_string_from_xml!(self, e, vertical, "vertical");
        set_string_from_xml!(self, e, wrap_text, "wrapText");
        set_string_from_xml!(self, e, text_rotation, "textRotation");
    }

    pub(crate) fn write_to(&self, writer: &mut Writer<Cursor<Vec<u8>>>) {
        // alignment
        let mut attributes: crate::structs::AttrCollection = Vec::new();
        if self.horizontal.has_value() {
            attributes.push(("horizontal", self.horizontal.value_string()).into());
        }
        if self.vertical.has_value() {
            attributes.push(("vertical", self.vertical.value_string()).into());
        }
        if self.wrap_text.has_value() {
            attributes.push(("wrapText", self.wrap_text.value_string()).into());
        }
        let text_rotation = self.text_rotation.value_string();
        if self.text_rotation.has_value() {
            attributes.push(("textRotation", text_rotation).into());
        }
        write_start_tag(writer, "alignment", attributes, true);
    }
}