Struct xl::Workbook

pub struct Workbook {
    pub path: String,
    pub date_system: DateSystem,
    /* private fields */
}

The Workbook is the primary object you will use in this module. The public interface allows you to see the path of the workbook as well as its date system.

Example usage:

use xl::Workbook;
let mut wb = Workbook::open("tests/data/Book1.xlsx").unwrap();

Fields

path: String

date_system: DateSystem

Implementations

impl Workbook

pub fn sheets(&mut self) -> SheetMap

Return SheetMap of all sheets in this workbook. See SheetMap class and associated methods for more detailed documentation.

pub fn new(path: &str) -> Result<Self, String>

Open an existing workbook (xlsx file). Returns a Result in case there is an error opening the workbook.

Example usage:

use xl::Workbook;

let mut wb = Workbook::open("tests/data/Book1.xlsx");
assert!(wb.is_ok());

// non-existant file
let mut wb = Workbook::open("Non-existant xlsx");
assert!(wb.is_err());

// non-xlsx file
let mut wb = Workbook::open("src/main.rs");
assert!(wb.is_err());

pub fn open(path: &str) -> Result<Self, String>

Alternative name for Workbook::new.

pub fn contents(&mut self)

Simple method to print out all the inner files of the xlsx zip.

pub fn sheet_reader<'a>(&'a mut self, zip_target: &str) -> SheetReader<'a>

Create a SheetReader for the given worksheet. A SheetReader is a struct in the xl::Worksheet class that can be used to iterate over rows, etc. See documentation in the xl::Worksheet module for more information.

Trait Implementations

impl Debug for Workbook

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.