excelx 0.4.1

Type-safe XLSX read/write helpers for Rust structs.
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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
use std::collections::HashMap;
use std::io::{Cursor, Read, Seek};

use calamine::{Data, Range, Reader, Xlsx};

use crate::{CellValue, ColumnDef, ExcelError, ExcelRow, RowView, validate_columns};

/// Maximum number of rows in an XLSX worksheet, including the header row.
pub const XLSX_MAX_ROWS: usize = 1_048_576;

/// Maximum number of columns in an XLSX worksheet.
pub const XLSX_MAX_COLUMNS: usize = 16_384;

/// Selects a worksheet by workbook order or visible worksheet name.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum SheetRef<'a> {
    Index(usize),
    Name(&'a str),
}

/// Options for parsing an XLSX workbook.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct ReadOptions<'a> {
    pub sheet: SheetRef<'a>,
}

impl<'a> Default for ReadOptions<'a> {
    fn default() -> Self {
        Self {
            sheet: SheetRef::Index(0),
        }
    }
}

/// Optional safety limits for parsing untrusted or user-uploaded workbooks.
#[derive(Clone, Copy, Debug, Default, Eq, PartialEq)]
pub struct ReadLimits {
    /// Maximum number of non-empty data rows to parse per worksheet.
    pub max_rows: Option<usize>,
    /// Maximum number of schema columns accepted for the row type.
    pub max_columns: Option<usize>,
}

impl ReadLimits {
    pub const fn new() -> Self {
        Self {
            max_rows: None,
            max_columns: None,
        }
    }

    pub const fn max_rows(mut self, max_rows: usize) -> Self {
        self.max_rows = Some(max_rows);
        self
    }

    pub const fn max_columns(mut self, max_columns: usize) -> Self {
        self.max_columns = Some(max_columns);
        self
    }
}

/// Optional safety limits for parsing homogeneous multi-sheet workbooks.
#[derive(Clone, Copy, Debug, Default, Eq, PartialEq)]
pub struct MultiSheetReadLimits {
    /// Maximum number of worksheets to parse.
    pub max_sheets: Option<usize>,
    /// Maximum number of non-empty data rows to parse per worksheet.
    pub max_rows_per_sheet: Option<usize>,
    /// Maximum number of schema columns accepted for the row type.
    pub max_columns_per_sheet: Option<usize>,
}

impl MultiSheetReadLimits {
    pub const fn new() -> Self {
        Self {
            max_sheets: None,
            max_rows_per_sheet: None,
            max_columns_per_sheet: None,
        }
    }

    pub const fn max_sheets(mut self, max_sheets: usize) -> Self {
        self.max_sheets = Some(max_sheets);
        self
    }

    pub const fn max_rows_per_sheet(mut self, max_rows_per_sheet: usize) -> Self {
        self.max_rows_per_sheet = Some(max_rows_per_sheet);
        self
    }

    pub const fn max_columns_per_sheet(mut self, max_columns_per_sheet: usize) -> Self {
        self.max_columns_per_sheet = Some(max_columns_per_sheet);
        self
    }
}

/// Parsed rows for one worksheet in a homogeneous multi-sheet workbook.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct ParsedSheet<T> {
    pub name: String,
    pub rows: Vec<T>,
}

impl<T> ParsedSheet<T> {
    pub fn new(name: impl Into<String>, rows: Vec<T>) -> Self {
        Self {
            name: name.into(),
            rows,
        }
    }
}

/// Parse the first worksheet in an XLSX byte slice into typed rows.
pub fn from_xlsx<T: ExcelRow>(bytes: &[u8]) -> Result<Vec<T>, ExcelError> {
    from_reader(Cursor::new(bytes))
}

/// Parse the first worksheet in an XLSX reader into typed rows.
pub fn from_reader<T: ExcelRow, R: Read + Seek>(reader: R) -> Result<Vec<T>, ExcelError> {
    from_reader_with_options(reader, ReadOptions::default())
}

/// Parse one selected worksheet in an XLSX byte slice into typed rows.
pub fn from_xlsx_sheet<T: ExcelRow>(
    bytes: &[u8],
    sheet: SheetRef<'_>,
) -> Result<Vec<T>, ExcelError> {
    from_xlsx_with_options(bytes, ReadOptions { sheet })
}

/// Parse one selected worksheet in an XLSX byte slice with explicit safety limits.
pub fn from_xlsx_with_limits<T: ExcelRow>(
    bytes: &[u8],
    sheet: SheetRef<'_>,
    limits: ReadLimits,
) -> Result<Vec<T>, ExcelError> {
    from_reader_with_limits(Cursor::new(bytes), sheet, limits)
}

/// Parse one selected worksheet in an XLSX byte slice with explicit options.
pub fn from_xlsx_with_options<T: ExcelRow>(
    bytes: &[u8],
    options: ReadOptions<'_>,
) -> Result<Vec<T>, ExcelError> {
    from_reader_with_options(Cursor::new(bytes), options)
}

/// Parse one selected worksheet in an XLSX reader with explicit options.
pub fn from_reader_with_options<T: ExcelRow, R: Read + Seek>(
    reader: R,
    options: ReadOptions<'_>,
) -> Result<Vec<T>, ExcelError> {
    from_reader_with_limits(reader, options.sheet, ReadLimits::default())
}

/// Parse one selected worksheet in an XLSX reader with explicit safety limits.
pub fn from_reader_with_limits<T: ExcelRow, R: Read + Seek>(
    reader: R,
    sheet: SheetRef<'_>,
    limits: ReadLimits,
) -> Result<Vec<T>, ExcelError> {
    let columns = T::columns();
    let sorted_columns = validate_columns(&columns)?;
    validate_column_limit("schema", sorted_columns.len(), limits.max_columns)?;
    let mut workbook: Xlsx<R> = Xlsx::new(reader)?;
    let range = worksheet_range(&mut workbook, sheet)?;

    parse_range(range, &columns, &sorted_columns, limits)
}

/// Parse all worksheets in an XLSX byte slice as the same row type.
pub fn from_xlsx_multi<T: ExcelRow>(bytes: &[u8]) -> Result<Vec<ParsedSheet<T>>, ExcelError> {
    from_reader_multi(Cursor::new(bytes))
}

/// Parse all worksheets in an XLSX byte slice with explicit safety limits.
pub fn from_xlsx_multi_with_limits<T: ExcelRow>(
    bytes: &[u8],
    limits: MultiSheetReadLimits,
) -> Result<Vec<ParsedSheet<T>>, ExcelError> {
    from_reader_multi_with_limits(Cursor::new(bytes), limits)
}

/// Parse all worksheets in an XLSX reader as the same row type.
pub fn from_reader_multi<T: ExcelRow, R: Read + Seek>(
    reader: R,
) -> Result<Vec<ParsedSheet<T>>, ExcelError> {
    from_reader_multi_with_limits(reader, MultiSheetReadLimits::default())
}

/// Parse all worksheets in an XLSX reader with explicit safety limits.
pub fn from_reader_multi_with_limits<T: ExcelRow, R: Read + Seek>(
    reader: R,
    limits: MultiSheetReadLimits,
) -> Result<Vec<ParsedSheet<T>>, ExcelError> {
    let columns = T::columns();
    let sorted_columns = validate_columns(&columns)?;
    validate_column_limit("schema", sorted_columns.len(), limits.max_columns_per_sheet)?;
    let mut workbook: Xlsx<R> = Xlsx::new(reader)?;
    let sheet_names = workbook.sheet_names();

    if sheet_names.is_empty() {
        return Err(ExcelError::Parse(
            "workbook does not contain any worksheets".to_owned(),
        ));
    }
    validate_sheet_limit(sheet_names.len(), limits.max_sheets)?;

    let mut parsed_sheets = Vec::with_capacity(sheet_names.len());
    for name in sheet_names {
        let range = workbook.worksheet_range(&name)?;
        let rows = parse_range(
            range,
            &columns,
            &sorted_columns,
            ReadLimits {
                max_rows: limits.max_rows_per_sheet,
                max_columns: limits.max_columns_per_sheet,
            },
        )?;
        parsed_sheets.push(ParsedSheet::new(name, rows));
    }

    Ok(parsed_sheets)
}

fn parse_range<T: ExcelRow>(
    range: Range<Data>,
    columns: &[ColumnDef],
    sorted_columns: &[ColumnDef],
    limits: ReadLimits,
) -> Result<Vec<T>, ExcelError> {
    let mut rows = range.rows();
    let header_row = rows
        .next()
        .ok_or_else(|| ExcelError::Parse("worksheet does not contain a header row".to_owned()))?;
    let header_map = build_header_map(header_row)?;
    validate_column_limit("worksheet", header_map.len(), limits.max_columns)?;
    ensure_required_headers(sorted_columns, &header_map)?;

    let mut parsed_rows = Vec::new();
    for (relative_index, row) in rows.enumerate() {
        if is_empty_row(row) {
            continue;
        }

        let excel_row_number = relative_index + 2;
        validate_row_limit(parsed_rows.len() + 1, limits.max_rows)?;
        let values = values_for_schema(row, columns, &header_map)?;
        let row_view = RowView::new(excel_row_number, columns, values);
        parsed_rows.push(T::from_row(&row_view)?);
    }

    Ok(parsed_rows)
}

fn worksheet_range<R: Read + Seek>(
    workbook: &mut Xlsx<R>,
    sheet: SheetRef<'_>,
) -> Result<Range<Data>, ExcelError> {
    match sheet {
        SheetRef::Index(index) => workbook
            .worksheet_range_at(index)
            .ok_or_else(|| missing_sheet_by_index(index))?
            .map_err(ExcelError::from),
        SheetRef::Name(name) => {
            if !workbook
                .sheet_names()
                .iter()
                .any(|sheet_name| sheet_name == name)
            {
                return Err(missing_sheet_by_name(name));
            }

            workbook.worksheet_range(name).map_err(ExcelError::from)
        }
    }
}

fn missing_sheet_by_index(index: usize) -> ExcelError {
    if index == 0 {
        ExcelError::Parse("workbook does not contain any worksheets".to_owned())
    } else {
        ExcelError::Parse(format!("worksheet index {index} does not exist"))
    }
}

fn missing_sheet_by_name(name: &str) -> ExcelError {
    ExcelError::Parse(format!("worksheet named `{name}` does not exist"))
}

fn validate_column_limit(
    label: &str,
    count: usize,
    limit: Option<usize>,
) -> Result<(), ExcelError> {
    if count > XLSX_MAX_COLUMNS {
        return Err(ExcelError::LimitExceeded(format!(
            "{label} defines {count} columns but XLSX supports at most {XLSX_MAX_COLUMNS}"
        )));
    }

    if let Some(limit) = limit {
        if count > limit {
            return Err(ExcelError::LimitExceeded(format!(
                "{label} defines {count} columns but configured max is {limit}"
            )));
        }
    }

    Ok(())
}

fn validate_row_limit(count: usize, limit: Option<usize>) -> Result<(), ExcelError> {
    let max_data_rows = XLSX_MAX_ROWS - 1;
    if count > max_data_rows {
        return Err(ExcelError::LimitExceeded(format!(
            "worksheet contains {count} data rows but XLSX supports at most {max_data_rows}"
        )));
    }

    if let Some(limit) = limit {
        if count > limit {
            return Err(ExcelError::LimitExceeded(format!(
                "worksheet contains {count} data rows but configured max is {limit}"
            )));
        }
    }

    Ok(())
}

fn validate_sheet_limit(count: usize, limit: Option<usize>) -> Result<(), ExcelError> {
    if let Some(limit) = limit {
        if count > limit {
            return Err(ExcelError::LimitExceeded(format!(
                "workbook contains {count} worksheets but configured max is {limit}"
            )));
        }
    }

    Ok(())
}

fn build_header_map(row: &[Data]) -> Result<HashMap<String, usize>, ExcelError> {
    let mut headers = HashMap::with_capacity(row.len());

    for (index, cell) in row.iter().enumerate() {
        if matches!(cell, Data::Empty) {
            continue;
        }

        let header = match cell {
            Data::String(value) => value.trim().to_owned(),
            Data::Int(value) => value.to_string(),
            Data::Float(value) => value.to_string(),
            Data::Bool(value) => value.to_string(),
            other => {
                return Err(ExcelError::Parse(format!(
                    "unsupported header cell type at column {}: {other}",
                    index + 1
                )));
            }
        };

        if header.is_empty() {
            continue;
        }

        if headers.insert(header.clone(), index).is_some() {
            return Err(ExcelError::DuplicateHeader(header));
        }
    }

    Ok(headers)
}

fn ensure_required_headers(
    columns: &[ColumnDef],
    header_map: &HashMap<String, usize>,
) -> Result<(), ExcelError> {
    for column in columns {
        if !header_map.contains_key(column.header) {
            return Err(ExcelError::MissingHeader(column.header.to_owned()));
        }
    }

    Ok(())
}

fn values_for_schema(
    row: &[Data],
    columns: &[ColumnDef],
    header_map: &HashMap<String, usize>,
) -> Result<Vec<CellValue>, ExcelError> {
    columns
        .iter()
        .map(|column| {
            let index = header_map
                .get(column.header)
                .ok_or_else(|| ExcelError::MissingHeader(column.header.to_owned()))?;

            row.get(*index)
                .map(CellValue::try_from)
                .unwrap_or(Ok(CellValue::Empty))
        })
        .collect()
}

fn is_empty_row(row: &[Data]) -> bool {
    row.iter().all(|cell| matches!(cell, Data::Empty))
}