Struct polars::prelude::CsvWriter

pub struct CsvWriter<W>
where
    W: Write,
{ /* private fields */ }

Available on crate feature polars-io only.

Write a DataFrame to csv.

Don’t use a Buffered writer, the CsvWriter internally already buffers writes.

Implementations

impl<W> CsvWriter<W>

where W: Write,

pub fn include_bom(self, include_bom: bool) -> CsvWriter<W>

Set whether to write UTF-8 BOM.

pub fn include_header(self, include_header: bool) -> CsvWriter<W>

Set whether to write headers.

pub fn with_separator(self, separator: u8) -> CsvWriter<W>

Set the CSV file’s column separator as a byte character.

pub fn with_batch_size(self, batch_size: NonZero<usize>) -> CsvWriter<W>

Set the batch size to use while writing the CSV.

pub fn with_date_format(self, format: Option<String>) -> CsvWriter<W>

Set the CSV file’s date format.

pub fn with_time_format(self, format: Option<String>) -> CsvWriter<W>

Set the CSV file’s time format.

pub fn with_datetime_format(self, format: Option<String>) -> CsvWriter<W>

Set the CSV file’s datetime format.

pub fn with_float_precision(self, precision: Option<usize>) -> CsvWriter<W>

Set the CSV file’s float precision.

pub fn with_quote_char(self, char: u8) -> CsvWriter<W>

Set the single byte character used for quoting.

pub fn with_null_value(self, null_value: String) -> CsvWriter<W>

Set the CSV file’s null value representation.

pub fn with_line_terminator(self, line_terminator: String) -> CsvWriter<W>

Set the CSV file’s line terminator.

pub fn with_quote_style(self, quote_style: QuoteStyle) -> CsvWriter<W>

Set the CSV file’s quoting behavior. See more on QuoteStyle.

pub fn n_threads(self, n_threads: usize) -> CsvWriter<W>

pub fn batched(self, schema: &Schema) -> Result<BatchedWriter<W>, PolarsError>

Trait Implementations

impl<W> SerWriter<W> for CsvWriter<W>

where W: Write,

fn new(buffer: W) -> CsvWriter<W>

fn finish(&mut self, df: &mut DataFrame) -> Result<(), PolarsError>