arrow_csv::writer

Struct WriterBuilder

Source
pub struct WriterBuilder {
    delimiter: u8,
    has_header: bool,
    quote: u8,
    escape: u8,
    double_quote: bool,
    date_format: Option<String>,
    datetime_format: Option<String>,
    timestamp_format: Option<String>,
    timestamp_tz_format: Option<String>,
    time_format: Option<String>,
    null_value: Option<String>,
}
Expand description

A CSV writer builder

Fields§

§delimiter: u8

Optional column delimiter. Defaults to b','

§has_header: bool

Whether to write column names as file headers. Defaults to true

§quote: u8

Optional quote character. Defaults to b'"'

§escape: u8

Optional escape character. Defaults to b'\\'

§double_quote: bool

Enable double quote escapes. Defaults to true

§date_format: Option<String>

Optional date format for date arrays

§datetime_format: Option<String>

Optional datetime format for datetime arrays

§timestamp_format: Option<String>

Optional timestamp format for timestamp arrays

§timestamp_tz_format: Option<String>

Optional timestamp format for timestamp with timezone arrays

§time_format: Option<String>

Optional time format for time arrays

§null_value: Option<String>

Optional value to represent null

Implementations§

Source§

impl WriterBuilder

Source

pub fn new() -> Self

Create a new builder for configuring CSV writing options.

To convert a builder into a writer, call WriterBuilder::build

§Example

fn example() -> Writer<File> {
    let file = File::create("target/out.csv").unwrap();

    // create a builder that doesn't write headers
    let builder = WriterBuilder::new().with_header(false);
    let writer = builder.build(file);

    writer
}
Source

pub fn with_header(self, header: bool) -> Self

Set whether to write the CSV file with a header

Source

pub fn header(&self) -> bool

Returns true if this writer is configured to write a header

Source

pub fn with_delimiter(self, delimiter: u8) -> Self

Set the CSV file’s column delimiter as a byte character

Source

pub fn delimiter(&self) -> u8

Get the CSV file’s column delimiter as a byte character

Source

pub fn with_quote(self, quote: u8) -> Self

Set the CSV file’s quote character as a byte character

Source

pub fn quote(&self) -> u8

Get the CSV file’s quote character as a byte character

Source

pub fn with_escape(self, escape: u8) -> Self

Set the CSV file’s escape character as a byte character

In some variants of CSV, quotes are escaped using a special escape character like \ (instead of escaping quotes by doubling them).

By default, writing these idiosyncratic escapes is disabled, and is only used when double_quote is disabled.

Source

pub fn escape(&self) -> u8

Get the CSV file’s escape character as a byte character

Source

pub fn with_double_quote(self, double_quote: bool) -> Self

Set whether to enable double quote escapes

When enabled (which is the default), quotes are escaped by doubling them. e.g., " escapes to "".

When disabled, quotes are escaped with the escape character (which is \\ by default).

Source

pub fn double_quote(&self) -> bool

Get whether double quote escapes are enabled

Source

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

Set the CSV file’s date format

Source

pub fn date_format(&self) -> Option<&str>

Get the CSV file’s date format if set, defaults to RFC3339

Source

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

Set the CSV file’s datetime format

Source

pub fn datetime_format(&self) -> Option<&str>

Get the CSV file’s datetime format if set, defaults to RFC3339

Source

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

Set the CSV file’s time format

Source

pub fn time_format(&self) -> Option<&str>

Get the CSV file’s datetime time if set, defaults to RFC3339

Source

pub fn with_timestamp_format(self, format: String) -> Self

Set the CSV file’s timestamp format

Source

pub fn timestamp_format(&self) -> Option<&str>

Get the CSV file’s timestamp format if set, defaults to RFC3339

Source

pub fn with_timestamp_tz_format(self, tz_format: String) -> Self

Set the CSV file’s timestamp tz format

Source

pub fn timestamp_tz_format(&self) -> Option<&str>

Get the CSV file’s timestamp tz format if set, defaults to RFC3339

Source

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

Set the value to represent null in output

Source

pub fn null(&self) -> &str

Get the value to represent null in output

Source

pub fn with_rfc3339(self) -> Self

👎Deprecated: Use WriterBuilder::default()

Use RFC3339 format for date/time/timestamps (default)

Source

pub fn build<W: Write>(self, writer: W) -> Writer<W>

Create a new Writer

Trait Implementations§

Source§

impl Clone for WriterBuilder

Source§

fn clone(&self) -> WriterBuilder

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for WriterBuilder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for WriterBuilder

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

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

Source§

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<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,