Struct Xls

pub struct Xls<RS> { /* private fields */ }

A struct representing an old xls format file (CFB)

Implementations

impl<RS: Read + Seek> Xls<RS>

pub fn new_with_options( reader: RS, options: XlsOptions, ) -> Result<Self, XlsError>

Creates a new instance using Options to inform parsing.

use calamine::{Xls,XlsOptions};

let mut options = XlsOptions::default();
// ...set options...
let workbook = Xls::new_with_options(reader, options)?;

pub fn worksheet_merge_cells(&self, name: &str) -> Option<Vec<Dimensions>>

Gets the worksheet merge cell dimensions

pub fn worksheet_merge_cells_at(&self, n: usize) -> Option<Vec<Dimensions>>

Get the nth worksheet. Shortcut for getting the nth sheet_name, then the corresponding worksheet.

Trait Implementations

impl<RS: Read + Seek> Reader<RS> for Xls<RS>

fn metadata(&self) -> &Metadata

Parses Workbook stream, no need for the relationships variable

type Error = XlsError

Error specific to file type

fn new(reader: RS) -> Result<Self, XlsError>

Creates a new instance.

fn with_header_row(&mut self, header_row: HeaderRow) -> &mut Self

Set header row (i.e. first row to be read) If header_row is None, the first non-empty row will be used as header row

fn vba_project(&mut self) -> Option<Result<Cow<'_, VbaProject>, XlsError>>

Gets VbaProject

fn worksheet_range(&mut self, name: &str) -> Result<Range<Data>, XlsError>

Read worksheet data in corresponding worksheet path

fn worksheets(&mut self) -> Vec<(String, Range<Data>)>

Fetch all worksheet data & paths

fn worksheet_formula(&mut self, name: &str) -> Result<Range<String>, XlsError>

Read worksheet formula in corresponding worksheet path

fn sheet_names(&self) -> Vec<String>

Get all sheet names of this workbook, in workbook order

fn sheets_metadata(&self) -> &[Sheet]

Fetch all sheets metadata

fn defined_names(&self) -> &[(String, String)]

Get all defined names (Ranges names etc)

fn worksheet_range_at( &mut self, n: usize, ) -> Option<Result<Range<Data>, Self::Error>>

Get the nth worksheet. Shortcut for getting the nth sheet_name, then the corresponding worksheet.