Struct ExcelOptions

#[non_exhaustive]
pub struct ExcelOptions {
    pub sheet_names: Option<Vec<String>>,
    pub sheet_indexes: Option<Vec<i32>>,
    pub header_row: Option<bool>,
}

Represents a set of options that define how DataBrew will interpret a Microsoft Excel file when creating a dataset from that file.

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.

sheet_names: Option<Vec<String>>

One or more named sheets in the Excel file that will be included in the dataset.

sheet_indexes: Option<Vec<i32>>

One or more sheet numbers in the Excel file that will be included in the dataset.

header_row: Option<bool>

A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated.

Implementations

impl ExcelOptions

pub fn sheet_names(&self) -> &[String]

One or more named sheets in the Excel file that will be included in the dataset.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .sheet_names.is_none().

pub fn sheet_indexes(&self) -> &[i32]

One or more sheet numbers in the Excel file that will be included in the dataset.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .sheet_indexes.is_none().

pub fn header_row(&self) -> Option<bool>

A variable that specifies whether the first row in the file is parsed as the header. If this value is false, column names are auto-generated.

impl ExcelOptions

pub fn builder() -> ExcelOptionsBuilder

Creates a new builder-style object to manufacture ExcelOptions.

Trait Implementations

impl Clone for ExcelOptions

fn clone(&self) -> ExcelOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ExcelOptions

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

Formats the value using the given formatter.

impl PartialEq for ExcelOptions

fn eq(&self, other: &ExcelOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ExcelOptions