Struct Delimited 

pub struct Delimited {
    pub delimiter: Option<u8>,
    pub comment_char: Option<String>,
    pub skip_initial_space: Option<bool>,
    pub header_rows: Option<HeaderRows>,
    pub header_join: Option<String>,
    pub metadata_line: Option<usize>,
    pub null_values: Vec<String>,
    pub skip_lines: Option<usize>,
    pub columns: Vec<Derived>,
    pub types: Vec<(String, ColumnType)>,
}

A delimited spec’s reading options. Each one left out keeps what the command line or the config says.

Fields

delimiter: Option<u8>

comment_char: Option<String>

skip_initial_space: Option<bool>

header_rows: Option<HeaderRows>

header_join: Option<String>

metadata_line: Option<usize>

null_values: Vec<String>

skip_lines: Option<usize>

columns: Vec<Derived>

types: Vec<(String, ColumnType)>

Columns of the file read as a declared type, by name.

Implementations

impl Delimited

pub fn apply(&self, options: &mut OpenOptions)

options with the spec’s dialect: each option the spec gives replaces what the config said, but not a flag typed on the command line (#651), and the file is read as CSV unless its name says TSV or PSV.

pub fn head_lines(&self) -> Vec<usize>

The lines Self::facts reads, 1-based.

pub fn facts( &self, source: impl BufRead, separator: u8, join: &str, ) -> Result<HeadFacts>

The units and the metadata from the top of the text source holds, split on separator. Only the lines the spec names are read.

pub fn facts_of( &self, wanted: &[usize], lines: &[Vec<u8>], separator: u8, join: &str, ) -> HeadFacts

Self::facts from lines, the lines wanted names as crate::csv_dialect::named_lines read them; a line not among them is blank.

pub fn derive(&self, lf: LazyFrame) -> PolarsResult<LazyFrame>

lf with the derived columns, each before the first column it is made from. Lazy: nothing is read.

impl Delimited

pub fn summary(&self) -> String

The options the spec sets, in a line: header line 3, unit line 2, ....

Trait Implementations

impl Clone for Delimited

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Delimited

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

Formats the value using the given formatter.

impl Default for Delimited

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Delimited

impl PartialEq for Delimited

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Delimited