Struct Xlsx

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

A struct representing xml zipped excel file Xlsx, Xlsm, Xlam

Implementations

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

pub fn load_merged_regions(&mut self) -> Result<(), XlsxError>

Load the merged regions

pub fn merged_regions(&self) -> &Vec<(String, String, Dimensions)>

Get the merged regions of all the sheets

pub fn merged_regions_by_sheet( &self, name: &str, ) -> Vec<(&String, &String, &Dimensions)>

Get the merged regions by sheet name

pub fn load_tables(&mut self) -> Result<(), XlsxError>

Load the tables from

pub fn table_names(&self) -> Vec<&String>

Get the names of all the tables

pub fn table_names_in_sheet(&self, sheet_name: &str) -> Vec<&String>

Get the names of all the tables in a sheet

pub fn table_by_name( &mut self, table_name: &str, ) -> Result<Table<Data>, XlsxError>

Get the table by name (owned)

pub fn table_by_name_ref( &mut self, table_name: &str, ) -> Result<Table<DataRef<'_>>, XlsxError>

Get the table by name (ref)

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

Gets the worksheet merge cell dimensions

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

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

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

pub fn worksheet_cells_reader<'a>( &'a mut self, name: &str, ) -> Result<XlsxCellReader<'a>, XlsxError>

Get a reader over all used cells in the given worksheet cell reader

Trait Implementations

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

type Error = XlsxError

Error specific to file type

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

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>, XlsxError>>

Gets VbaProject

fn metadata(&self) -> &Metadata

Initialize

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

Read worksheet data in corresponding worksheet path

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

Read worksheet formula in corresponding worksheet path

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

Fetch all worksheet data & paths

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.

impl<RS: Read + Seek> ReaderRef<RS> for Xlsx<RS>

fn worksheet_range_ref<'a>( &'a mut self, name: &str, ) -> Result<Range<DataRef<'a>>, XlsxError>

Get worksheet range where shared string values are only borrowed.

fn worksheet_range_at_ref( &mut self, n: usize, ) -> Option<Result<Range<DataRef<'_>>, Self::Error>>

Get the nth worksheet range where shared string values are only borrowed. Shortcut for getting the nth sheet_name, then the corresponding worksheet.