Struct polars_io::csv::CsvWriter

source ·
pub struct CsvWriter<W: Write> { /* private fields */ }
Available on crate features csv or json 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) -> Self

Set whether to write UTF-8 BOM.

source

pub fn include_header(self, include_header: bool) -> Self

Set whether to write headers.

source

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

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

source

pub fn with_batch_size(self, batch_size: NonZeroUsize) -> Self

Set the batch size to use while writing the CSV.

source

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

Set the CSV file’s date format.

source

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

Set the CSV file’s time format.

source

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

Set the CSV file’s datetime format.

source

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

Set the CSV file’s float precision.

source

pub fn with_quote_char(self, char: u8) -> Self

Set the single byte character used for quoting.

source

pub fn with_null_value(self, null_value: String) -> Self

Set the CSV file’s null value representation.

source

pub fn with_line_terminator(self, line_terminator: String) -> Self

Set the CSV file’s line terminator.

source

pub fn with_quote_style(self, quote_style: QuoteStyle) -> Self

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

source

pub fn n_threads(self, n_threads: usize) -> Self

source

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

Trait Implementations§

source§

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

source§

fn new(buffer: W) -> Self

source§

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

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

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

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more