LoadOptions

Struct LoadOptions 

Source
pub struct LoadOptions {
    pub delimiter: Delimiter,
    pub has_header: bool,
    pub skip_rows: usize,
    pub max_rows: Option<usize>,
    pub sheet_index: Option<usize>,
    pub sheet_name: Option<String>,
    pub infer_schema: bool,
    pub infer_schema_length: Option<usize>,
}
Expand description

Configuration options for loading data files.

This struct uses the builder pattern for a flexible, extensible API.

§Examples

use dataload::{LoadOptions, Delimiter};

// Default options
let opts = LoadOptions::default();

// Custom options
let opts = LoadOptions::new()
    .with_delimiter(Delimiter::Tab)
    .with_header(false)
    .with_skip_rows(1);

Fields§

§delimiter: Delimiter

The delimiter to use for CSV parsing.

§has_header: bool

Whether the first row contains headers.

§skip_rows: usize

Number of rows to skip from the start.

§max_rows: Option<usize>

Maximum number of rows to read (None = all rows).

§sheet_index: Option<usize>

For Excel files: which sheet to read (0-indexed). None means read the first sheet.

§sheet_name: Option<String>

For Excel files: sheet name to read. Takes precedence over sheet_index if both are set.

§infer_schema: bool

Whether to infer data types for columns.

§infer_schema_length: Option<usize>

Number of rows to use for schema inference.

Implementations§

Source§

impl LoadOptions

Source

pub fn new() -> Self

Creates a new LoadOptions with default values.

Source

pub const fn with_delimiter(self, delimiter: Delimiter) -> Self

Sets the delimiter for CSV parsing.

Use Delimiter::Auto (default) for automatic detection.

Source

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

Sets whether the first row contains headers.

Default is true.

Source

pub const fn with_skip_rows(self, skip_rows: usize) -> Self

Sets the number of rows to skip from the start of the file.

This is applied before header detection, so if skip_rows = 1 and has_header = true, the second row becomes the header.

Source

pub const fn with_max_rows(self, max_rows: Option<usize>) -> Self

Sets the maximum number of rows to read.

None means read all rows (default).

Source

pub const fn with_sheet_index(self, index: usize) -> Self

Sets the sheet index to read from Excel files (0-indexed).

Source

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

Sets the sheet name to read from Excel files.

Takes precedence over sheet_index if both are set.

Source

pub const fn with_infer_schema(self, infer: bool) -> Self

Sets whether to infer data types for columns.

Default is true.

Source

pub const fn with_infer_schema_length(self, length: Option<usize>) -> Self

Sets the number of rows to use for schema inference.

None means use all rows. Default is Some(1000).

Trait Implementations§

Source§

impl Clone for LoadOptions

Source§

fn clone(&self) -> LoadOptions

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for LoadOptions

Source§

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

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

impl Default for LoadOptions

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V