Struct polars::prelude::CsvReadOptions

source ·
pub struct CsvReadOptions {
Show 20 fields pub path: Option<PathBuf>, pub rechunk: bool, pub n_threads: Option<usize>, pub low_memory: bool, pub n_rows: Option<usize>, pub row_index: Option<RowIndex>, pub columns: Option<Arc<Vec<String>>>, pub projection: Option<Arc<Vec<usize>>>, pub schema: Option<Arc<Schema>>, pub schema_overwrite: Option<Arc<Schema>>, pub dtype_overwrite: Option<Arc<Vec<DataType>>>, pub parse_options: Arc<CsvParseOptions>, pub has_header: bool, pub sample_size: usize, pub chunk_size: usize, pub skip_rows: usize, pub skip_rows_after_header: usize, pub infer_schema_length: Option<usize>, pub raise_if_empty: bool, pub ignore_errors: bool,
}
Available on crate feature polars-io only.

Fields§

§path: Option<PathBuf>§rechunk: bool§n_threads: Option<usize>§low_memory: bool§n_rows: Option<usize>§row_index: Option<RowIndex>§columns: Option<Arc<Vec<String>>>§projection: Option<Arc<Vec<usize>>>§schema: Option<Arc<Schema>>§schema_overwrite: Option<Arc<Schema>>§dtype_overwrite: Option<Arc<Vec<DataType>>>§parse_options: Arc<CsvParseOptions>§has_header: bool§sample_size: usize§chunk_size: usize§skip_rows: usize§skip_rows_after_header: usize§infer_schema_length: Option<usize>§raise_if_empty: bool§ignore_errors: bool

Implementations§

source§

impl CsvReadOptions

source

pub fn get_parse_options(&self) -> Arc<CsvParseOptions>

source

pub fn with_path<P>(self, path: Option<P>) -> CsvReadOptions
where P: Into<PathBuf>,

source

pub fn with_rechunk(self, rechunk: bool) -> CsvReadOptions

Whether to makes the columns contiguous in memory.

source

pub fn with_n_threads(self, n_threads: Option<usize>) -> CsvReadOptions

Number of threads to use for reading. Defaults to the size of the polars thread pool.

source

pub fn with_low_memory(self, low_memory: bool) -> CsvReadOptions

Reduce memory consumption at the expense of performance

source

pub fn with_n_rows(self, n_rows: Option<usize>) -> CsvReadOptions

Limits the number of rows to read.

source

pub fn with_row_index(self, row_index: Option<RowIndex>) -> CsvReadOptions

Adds a row index column.

source

pub fn with_columns(self, columns: Option<Arc<Vec<String>>>) -> CsvReadOptions

Which columns to select.

source

pub fn with_projection( self, projection: Option<Arc<Vec<usize>>> ) -> CsvReadOptions

Which columns to select denoted by their index. The index starts from 0 (i.e. [0, 4] would select the 1st and 5th column).

source

pub fn with_schema(self, schema: Option<Arc<Schema>>) -> CsvReadOptions

Set the schema to use for CSV file. The length of the schema must match the number of columns in the file. If this is None, the schema is inferred from the file.

source

pub fn with_schema_overwrite( self, schema_overwrite: Option<Arc<Schema>> ) -> CsvReadOptions

Overwrites the data types in the schema by column name.

source

pub fn with_dtype_overwrite( self, dtype_overwrite: Option<Arc<Vec<DataType>>> ) -> CsvReadOptions

Overwrite the dtypes in the schema in the order of the slice that’s given. This is useful if you don’t know the column names beforehand

source

pub fn with_parse_options( self, parse_options: CsvParseOptions ) -> CsvReadOptions

Sets the CSV parsing options. See map_parse_options for an easier way to mutate them in-place.

source

pub fn with_has_header(self, has_header: bool) -> CsvReadOptions

Sets whether the CSV file has a header row.

source

pub fn with_sample_size(self, sample_size: usize) -> CsvReadOptions

Sets the number of rows sampled from the file to determine approximately how much memory to use for the initial allocation.

source

pub fn with_chunk_size(self, chunk_size: usize) -> CsvReadOptions

Sets the chunk size used by the parser. This influences performance.

source

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

Number of rows to skip before the header row.

source

pub fn with_skip_rows_after_header( self, skip_rows_after_header: usize ) -> CsvReadOptions

Number of rows to skip after the header row.

source

pub fn with_infer_schema_length( self, infer_schema_length: Option<usize> ) -> CsvReadOptions

Number of rows to use for schema inference. Pass None to use all rows.

source

pub fn with_raise_if_empty(self, raise_if_empty: bool) -> CsvReadOptions

Whether to raise an error if the frame is empty. By default an empty DataFrame is returned.

source

pub fn with_ignore_errors(self, ignore_errors: bool) -> CsvReadOptions

Continue with next batch when a ParserError is encountered.

source

pub fn map_parse_options<F>(self, map_func: F) -> CsvReadOptions

Apply a function to the parse options.

source§

impl CsvReadOptions

source

pub fn try_into_reader_with_file_path( self, path: Option<PathBuf> ) -> Result<CsvReader<File>, PolarsError>

Creates a CSV reader using a file path.

§Panics

If both self.path and the path parameter are non-null. Only one of them is to be non-null.

source

pub fn into_reader_with_file_handle<R>(self, reader: R) -> CsvReader<R>
where R: MmapBytesReader,

Creates a CSV reader using a file handle.

source§

impl CsvReadOptions

source

pub fn update_with_inference_result( &mut self, si_result: &SchemaInferenceResult )

Note: This does not update the schema from the inference result.

Trait Implementations§

source§

impl Clone for CsvReadOptions

source§

fn clone(&self) -> CsvReadOptions

Returns a copy 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 CsvReadOptions

source§

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

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

impl Default for CsvReadOptions

source§

fn default() -> CsvReadOptions

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

impl Hash for CsvReadOptions

source§

fn hash<__H>(&self, state: &mut __H)
where __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl PartialEq for CsvReadOptions

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Eq for CsvReadOptions

source§

impl StructuralPartialEq for CsvReadOptions

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

source§

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

§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

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,

§

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>,

§

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>,

§

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.
§

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

§

fn vzip(self) -> V