excel-rs 1.0.1

A fast, low-allocation Rust library for writing XLSX (Excel) files.
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

use super::format::XlsxFormatter;
use crate::error::{ExcelError, Result};
use std::{
    collections::HashSet,
    io::{Seek, Write},
};
use zip::ZipWriter;

use super::sheet::Sheet;

/// A WorkBook represents one excel file.
pub struct WorkBook<W: Write + Seek> {
    formatter: XlsxFormatter<W>,
    sheet_names: HashSet<String>,
}

impl<W: Write + Seek> WorkBook<W> {
    /// Create a new WorkBook. `writer` is the destination to write the excel file to
    pub fn new(writer: W) -> Self {
        let zip_writer = ZipWriter::new(writer);

        WorkBook {
            formatter: XlsxFormatter::new(zip_writer),
            sheet_names: HashSet::new(),
        }
    }

    /// Creates a new Sheet with the given name.
    pub fn new_worksheet<'a>(&'a mut self, name: String) -> Result<Sheet<'a, W>> {
        if self.sheet_names.len() == crate::MAX_SHEETS {
            return Err(ExcelError::TooManySheets);
        }

        if self.sheet_names.contains(&name) {
            return Err(ExcelError::SheetAlreadyExists);
        }

        let id = self.sheet_names.len() as u16 + 1;
        self.sheet_names.insert(name.clone());
        Sheet::new(name, id, &mut self.formatter.zip_writer)
    }

    /// Finish writing to the excel file. This closes the file and wraps up any remaining operations.
    pub fn finish(self) -> Result<W> {
        self.formatter
            .finish(self.sheet_names.into_iter().collect::<Vec<String>>())
    }
}