Trait Reader

Source

pub trait Reader<RS>: Sizedwhere
    RS: Read + Seek,{
    type Error: Debug + From<Error>;

    // Required methods
    fn new(reader: RS) -> Result<Self, Self::Error>;
    fn with_header_row(&mut self, header_row: HeaderRow) -> &mut Self;
    fn vba_project(
        &mut self,
    ) -> Option<Result<Cow<'_, VbaProject>, Self::Error>>;
    fn metadata(&self) -> &Metadata;
    fn worksheet_range(
        &mut self,
        name: &str,
    ) -> Result<Range<Data>, Self::Error>;
    fn worksheets(&mut self) -> Vec<(String, Range<Data>)>;
    fn worksheet_formula(
        &mut self,
        _: &str,
    ) -> Result<Range<String>, Self::Error>;

    // Provided methods
    fn sheet_names(&self) -> Vec<String> { ... }
    fn sheets_metadata(&self) -> &[Sheet] { ... }
    fn defined_names(&self) -> &[(String, String)] { ... }
    fn worksheet_range_at(
        &mut self,
        n: usize,
    ) -> Option<Result<Range<Data>, Self::Error>> { ... }
}

Expand description

A trait to share spreadsheets reader functions across different FileTypes

Required Associated Types§

Source

type Error: Debug + From<Error>

Error specific to file type

Required Methods§

Source

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

Creates a new instance.

Source

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

Source

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

Gets VbaProject

Source

fn metadata(&self) -> &Metadata

Initialize

Source

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

Read worksheet data in corresponding worksheet path

Source

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

Fetch all worksheet data & paths

Source

fn worksheet_formula(&mut self, _: &str) -> Result<Range<String>, Self::Error>

Read worksheet formula in corresponding worksheet path

Provided Methods§

Source

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

Get all sheet names of this workbook, in workbook order

§Examples

use calamine::{Xlsx, open_workbook, Reader};

let mut workbook: Xlsx<_> = open_workbook(path).unwrap();
println!("Sheets: {:#?}", workbook.sheet_names());

Source