Skip to main content

ReadOptions

Struct ReadOptions 

Source
#[non_exhaustive]
pub struct ReadOptions { pub max_sample_rows: usize, pub sheet_name: Option<String>, pub has_header: bool, }
Expand description

Per-call read configuration. Construct via ReadOptions::default then layer on with the builder methods.

#[non_exhaustive] for forward-compat — same reasoning as Table / Column.

Fields (Non-exhaustive)§

This struct is marked as 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.
§max_sample_rows: usize

Maximum number of rows to surface in Table::sample_rows. Default: 100. Bounded so callers don’t accidentally pull 10M rows into memory chasing a ‘sample.’

§sheet_name: Option<String>

For multi-sheet XLSX/ODS, which sheet to read. None = the first non-empty sheet.

§has_header: bool

true (default) treats the first row as column headers. false generates column_0, column_1, … names and includes the first row in sample_rows.

Implementations§

Source§

impl ReadOptions

Source

pub fn max_sample_rows(self, n: usize) -> Self

Override the maximum sample-row count.

Source

pub fn sheet_name(self, name: impl Into<String>) -> Self

Select a specific sheet by name. Only meaningful for multi-sheet formats (XLSX, ODS); a no-op on CSV/TSV.

Source

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

Toggle header-row treatment. Defaults to true.

Trait Implementations§

Source§

impl Clone for ReadOptions

Source§

fn clone(&self) -> ReadOptions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ReadOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ReadOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.