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

use std::fmt;

use super::{
    RichText,
    Text,
};
use crate::CellErrorType;

#[derive(Clone, Debug, PartialEq, PartialOrd, Default)]
pub enum CellRawValue {
    String(Box<str>),
    RichText(RichText),
    Lazy(Box<str>),
    Numeric(f64),
    Bool(bool),
    Error(CellErrorType),
    #[default]
    Empty,
}
impl fmt::Display for CellRawValue {
    #[inline]
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            Self::String(v) => write!(f, "{v}"),
            Self::RichText(v) => write!(f, "{}", v.text()),
            Self::Numeric(v) => write!(f, "{v}"),
            Self::Bool(v) => write!(f, "{}", if *v { "TRUE" } else { "FALSE" }),
            Self::Error(e) => write!(f, "{e}"),
            _ => write!(f, ""),
        }
    }
}

impl CellRawValue {
    #[inline]
    #[must_use]
    pub fn data_type(&self) -> &str {
        match self {
            Self::String(_) | Self::RichText(_) => "s",
            Self::Numeric(_) => "n",
            Self::Bool(_) => "b",
            Self::Error(_) => "e",
            _ => "",
        }
    }

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

    #[inline]
    pub(crate) fn text(&self) -> Option<Text> {
        match self {
            Self::String(_) | // _
            Self::Numeric(_) | // _
            Self::Bool(_) => {
                let mut text = Text::default();
                text.set_value(self.to_string());
                Some(text)
            }
            _ => None,
        }
    }

    #[inline]
    #[deprecated(since = "3.0.0", note = "Use text()")]
    pub(crate) fn get_text(&self) -> Option<Text> {
        self.text()
    }

    #[inline]
    pub(crate) fn number(&self) -> Option<f64> {
        match self {
            Self::Numeric(number) => Some(*number),
            _ => None,
        }
    }

    #[inline]
    #[deprecated(since = "3.0.0", note = "Use number()")]
    pub(crate) fn get_number(&self) -> Option<f64> {
        self.number()
    }

    #[inline]
    #[must_use]
    pub fn rich_text(&self) -> Option<RichText> {
        match self {
            Self::RichText(v) => Some(v.clone()),
            _ => None,
        }
    }

    #[inline]
    #[must_use]
    #[deprecated(since = "3.0.0", note = "Use rich_text()")]
    pub fn get_rich_text(&self) -> Option<RichText> {
        self.rich_text()
    }

    #[inline]
    #[must_use]
    pub fn is_error(&self) -> bool {
        matches!(*self, CellRawValue::Error(_))
    }

    #[inline]
    #[must_use]
    pub fn is_empty(&self) -> bool {
        matches!(*self, CellRawValue::Empty)
    }
}