Struct OptionSet 

pub struct OptionSet {
    pub selected: Option<Vec<String>>,
    pub indices: Vec<u32>,
    pub path: Option<String>,
    pub rows: RowOptionSet,
    pub jsonl: bool,
    pub max: Option<u32>,
    pub omit_header: bool,
    pub header_row: u8,
    pub read_mode: ReadMode,
    pub field_mode: FieldNameMode,
}

Core options with nested row options

Fields

selected: Option<Vec<String>>

indices: Vec<u32>

path: Option<String>

rows: RowOptionSet

jsonl: bool

max: Option<u32>

omit_header: bool

header_row: u8

read_mode: ReadMode

field_mode: FieldNameMode

Implementations

impl OptionSet

pub fn new(path_str: &str) -> Self

Instantiates a new option set with a path string for file operations.

pub fn sheet_name(self, name: &str) -> Self

Sets the sheet name for the operation.

pub fn sheet_names(self, names: &[String]) -> Self

Sets the sheet name for the operation.

pub fn sheet_index(self, index: u32) -> Self

Sets the sheet index.

pub fn sheet_indices(self, indices: &[u32]) -> Self

Sets the sheet index.

pub fn json_lines(self) -> Self

Sets JSON Lines mode to true.

pub fn set_json_lines(self, mode: bool) -> Self

Sets JSON Lines mode

pub fn omit_header(self) -> Self

Omits the header when reading.

pub fn header_row(self, row: u8) -> Self

Sets the header row index.

pub fn max_row_count(self, max: u32) -> Self

Sets the maximum number of rows to read.

pub fn read_mode_async(self) -> Self

Sets the read mode to asynchronous, single sheet mode This is for reading long files with 10K+ rows in the target sheet

pub fn read_mode_preview(self) -> Self

Sets the read mode to direct with multiple sheet output This serves to fetch quick a overview of a spreadsheet

pub fn set_read_mode(self, key: &str) -> Self

Sets read mode from a range of common key names async, preview or sync (default) with synonyms such as a, p and s If the key is unmatched, it will always default to Sync

pub fn multimode(&self) -> bool

pub fn file_name(&self) -> Option<String>

pub fn override_headers(self, keys: &[&str]) -> Self

Override matched and unmatched headers with custom headers.

pub fn override_columns(self, cols: &[Value]) -> Self

Override matched and unmatched columns with custom keys and/or formatting options

pub fn field_name_mode(self, system: &str, override_header: bool) -> Self

Sets the column key naming convention.

pub fn row_mode(&self) -> String

pub fn header_mode(&self) -> String

pub fn to_json(&self) -> Value

render option output contextually as JSON

pub fn index_list(&self) -> String

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

render option output contextually as a list of strings for use in a terminal or text output

pub fn header_row_index(&self) -> usize

header row index as usize

pub fn max_rows(&self) -> usize

get the maximum of rows to be output synchronously

pub fn columns(&self) -> Vec<Column>

future development with advanced column options

pub fn read_mode(&self) -> ReadMode

cloned read mode

pub fn is_async(&self) -> bool

Needs full data set to processed later

pub fn capture_rows(&self) -> bool

Trait Implementations

impl Clone for OptionSet

fn clone(&self) -> OptionSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OptionSet

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

Formats the value using the given formatter.

impl Default for OptionSet

fn default() -> OptionSet

Returns the “default value” for a type.