Struct LoadSheetOrTableOptions 

#[non_exhaustive]
pub struct LoadSheetOrTableOptions {
    pub header_row: Option<usize>,
    pub column_names: Option<Vec<String>>,
    pub skip_rows: SkipRows,
    pub n_rows: Option<usize>,
    pub schema_sample_rows: Option<usize>,
    pub dtype_coercion: DTypeCoercion,
    pub selected_columns: SelectedColumns,
    pub dtypes: Option<DTypes>,
    pub skip_whitespace_tail_rows: bool,
    pub whitespace_as_null: bool,
}

Options for loading a sheet or table.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

header_row: Option<usize>

The index of the row containing the column labels. If None, the provided headers are used. Any row before the header row is skipped.

column_names: Option<Vec<String>>

The column names to use. If None, the column names are inferred from the header row.

skip_rows: SkipRows

How rows should be skipped.

n_rows: Option<usize>

The number of rows to read. If None, all rows are read.

schema_sample_rows: Option<usize>

The number of rows to sample for schema inference. If None, all rows are sampled.

dtype_coercion: DTypeCoercion

How data types should be coerced.

selected_columns: SelectedColumns

The columns to select.

dtypes: Option<DTypes>

Override the inferred data types.

skip_whitespace_tail_rows: bool

Skip rows at the end of the sheet/table containing only whitespace and null values.

whitespace_as_null: bool

Consider cells containing only whitespace as null values.

Implementations

impl LoadSheetOrTableOptions

pub fn new_for_sheet() -> Self

Returns a new LoadSheetOrTableOptions instance for loading a sheet. header_row is set to Some(0)

pub fn new_for_table() -> Self

Returns a new LoadSheetOrTableOptions instance for loading a sheet. header_row is set to None

pub fn header_row(self, header_row: usize) -> Self

pub fn no_header_row(self) -> Self

pub fn column_names<I: IntoIterator<Item = impl Into<String>>>( self, column_names: I, ) -> Self

pub fn skip_rows(self, skip_rows: SkipRows) -> Self

pub fn n_rows(self, n_rows: usize) -> Self

pub fn schema_sample_rows(self, schema_sample_rows: usize) -> Self

pub fn dtype_coercion(self, dtype_coercion: DTypeCoercion) -> Self

pub fn selected_columns(self, selected_columns: SelectedColumns) -> Self

pub fn with_dtypes(self, dtypes: DTypes) -> Self

pub fn skip_whitespace_tail_rows(self, skip_whitespace_tail_rows: bool) -> Self

pub fn whitespace_as_null(self, whitespace_as_null: bool) -> Self

Trait Implementations

impl Debug for LoadSheetOrTableOptions

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

Formats the value using the given formatter.