Struct polars_io::csv::read::CsvParseOptions

pub struct CsvParseOptions {
    pub separator: u8,
    pub quote_char: Option<u8>,
    pub eol_char: u8,
    pub encoding: CsvEncoding,
    pub null_values: Option<NullValues>,
    pub missing_is_null: bool,
    pub truncate_ragged_lines: bool,
    pub comment_prefix: Option<CommentPrefix>,
    pub try_parse_dates: bool,
    pub decimal_comma: bool,
}

Available on crate features csv or json only.

Fields

separator: u8

quote_char: Option<u8>

eol_char: u8

encoding: CsvEncoding

null_values: Option<NullValues>

missing_is_null: bool

truncate_ragged_lines: bool

comment_prefix: Option<CommentPrefix>

try_parse_dates: bool

decimal_comma: bool

Implementations

impl CsvParseOptions

pub fn with_separator(self, separator: u8) -> Self

The character used to separate fields in the CSV file. This is most often a comma ‘,’.

pub fn with_quote_char(self, quote_char: Option<u8>) -> Self

Set the character used for field quoting. This is most often double quotes ‘“’. Set this to None to disable quote parsing.

pub fn with_eol_char(self, eol_char: u8) -> Self

Set the character used to indicate an end-of-line (eol).

pub fn with_encoding(self, encoding: CsvEncoding) -> Self

Set the encoding used by the file.

pub fn with_null_values(self, null_values: Option<NullValues>) -> Self

Set values that will be interpreted as missing/null.

Note: These values are matched before quote-parsing, so if the null values are quoted then those quotes also need to be included here.

pub fn with_missing_is_null(self, missing_is_null: bool) -> Self

Treat missing fields as null.

pub fn with_truncate_ragged_lines(self, truncate_ragged_lines: bool) -> Self

Truncate lines that are longer than the schema.

pub fn with_comment_prefix<T: Into<CommentPrefix>>( self, comment_prefix: Option<T> ) -> Self

Sets the comment prefix for this instance. Lines starting with this prefix will be ignored.

pub fn with_try_parse_dates(self, try_parse_dates: bool) -> Self

Automatically try to parse dates/datetimes and time. If parsing fails, columns remain of dtype [DataType::String].

pub fn with_decimal_comma(self, decimal_comma: bool) -> Self

Parse floats with a comma as decimal separator.

Trait Implementations

impl Clone for CsvParseOptions

fn clone(&self) -> CsvParseOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CsvParseOptions

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

Formats the value using the given formatter.

impl Default for CsvParseOptions

Options related to parsing the CSV format.

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CsvParseOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for CsvParseOptions

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CsvParseOptions

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

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

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.

impl Serialize for CsvParseOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CsvParseOptions

impl StructuralPartialEq for CsvParseOptions