Struct CsvWriter

Source

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

Available on crate feature polars-io only.

Expand description

Write a DataFrame to csv.

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

Implementations§

Source §

impl<W> CsvWriter<W>
where W: Write,

Source

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

Set whether to write UTF-8 BOM.

Source

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

Set whether to write headers.

Source

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

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

Source

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

Set the batch size to use while writing the CSV.

Source

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

Set the CSV file’s date format.

Source

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

Set the CSV file’s time format.

Source

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

Set the CSV file’s datetime format.

Source

pub fn with_float_scientific(self, scientific: Option<bool>) -> CsvWriter<W>

Set the CSV file’s forced scientific notation for floats.

Source

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

Set the CSV file’s float precision.

Source

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

Set the single byte character used for quoting.

Source

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

Set the CSV file’s null value representation.

Source

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

Set the CSV file’s line terminator.

Source

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

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

Source

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

Source

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

Trait Implementations§

Source §

impl<W> SerWriter<W> for CsvWriter<W>
where W: Write,

Source §

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

Source §

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

Auto Trait Implementations§

§

impl<W> UnwindSafe for CsvWriter<W>
where W: UnwindSafe,

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

Source §

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into 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

§