excel_reader 2.0.2 

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

use anyhow::bail;

#[cfg(feature = "serde")]
use serde::Serialize;

use crate::{
    packaging::relationship::{zip_path_for_id, XlsxRelationships},
    raw::spreadsheet::workbook::sheet::XlsxSheet,
};

#[derive(Debug, Clone, PartialEq)]
#[cfg_attr(feature = "serde", derive(Serialize))]
pub struct SheetBasicInfo {
    /// id (Relationship Id)
    pub r_id: String,

    /// name (Sheet Name)
    pub name: String,

    /// sheetId (Sheet Tab Id)
    pub sheet_id: u64,

    /// state (Visible State)
    pub visible_state: SheetVisibleState,

    /// type
    pub r#type: SheetType,

    /// xml path
    #[cfg_attr(feature = "serde", serde(skip_serializing))]
    pub(crate) path: String,
}

impl SheetBasicInfo {
    pub(crate) fn from_raw(
        sheet: XlsxSheet,
        relationships: &XlsxRelationships,
    ) -> anyhow::Result<Self> {
        let (Some(id), Some(name), Some(sheet_id)) = (sheet.id, sheet.name, sheet.sheet_id) else {
            bail!("neccessary properties for sheet are not present.")
        };
        let Some(path) = zip_path_for_id(relationships, &id) else {
            bail!("Cannot find the xml file for the sheet.")
        };

        let sheet_type = match path.split('/').nth(1) {
            Some("worksheets") => SheetType::WorkSheet,
            Some("chartsheets") => SheetType::ChartSheet,
            Some("dialogsheets") => SheetType::DialogSheet,
            Some(t) => bail!("Unsupported sheet type: {}", t),
            None => bail!("sheet type not availalbe."),
        };

        let visibility = match sheet.visible_state.unwrap_or("visible".to_owned()).as_ref() {
            "visible" => SheetVisibleState::Visible,
            "hidden" => SheetVisibleState::Hidden,
            "veryHidden" => SheetVisibleState::VeryHidden,
            state => bail!("unknown sheet visible state: {}", state),
        };
        return Ok(Self {
            r_id: id,
            name,
            sheet_id,
            visible_state: visibility,
            r#type: sheet_type,
            path,
        });
    }
}

#[derive(Debug, Clone, Copy, PartialEq)]
#[cfg_attr(feature = "serde", derive(Serialize))]
#[cfg_attr(feature = "serde", serde(rename_all = "snake_case"))]
pub enum SheetType {
    /// WorkSheet
    WorkSheet,
    /// DialogSheet
    DialogSheet,
    /// ChartSheet
    ChartSheet,
}

/// https://learn.microsoft.com/en-us/dotnet/api/documentformat.openxml.spreadsheet.sheetstatevalues?view=openxml-3.0.1
#[derive(Debug, Clone, Copy, PartialEq)]
#[cfg_attr(feature = "serde", derive(Serialize))]
#[cfg_attr(feature = "serde", serde(rename_all = "snake_case"))]
pub enum SheetVisibleState {
    /// Visible
    Visible,
    /// Hidden
    Hidden,
    /// The sheet is hidden and cannot be displayed using the user interface.
    VeryHidden,
}