Struct WriterBuilder

pub struct WriterBuilder { /* private fields */ }

A builder for configuring a CSV writer.

This builder permits specifying the CSV delimiter, terminator, quoting style and more.

Implementations

impl WriterBuilder

pub fn new() -> WriterBuilder

Create a new builder for configuring a CSV writer.

pub fn build(&self) -> Writer

Builder a CSV writer from this configuration.

pub fn delimiter(&mut self, delimiter: u8) -> &mut WriterBuilder

The field delimiter to use when writing CSV.

The default is b','.

pub fn terminator(&mut self, term: Terminator) -> &mut WriterBuilder

The record terminator to use when writing CSV.

A record terminator can be any single byte. The default is \n.

Note that RFC 4180 specifies that record terminators should be \r\n. To use \r\n, use the special Terminator::CRLF value.

pub fn quote_style(&mut self, style: QuoteStyle) -> &mut WriterBuilder

The quoting style to use when writing CSV.

By default, this is set to QuoteStyle::Necessary, which will only use quotes when they are necessary to preserve the integrity of data.

Note that unless the quote style is set to Never, an empty field is quoted if it is the only field in a record.

pub fn quote(&mut self, quote: u8) -> &mut WriterBuilder

The quote character to use when writing CSV.

The default value is b'"'.

pub fn escape(&mut self, escape: u8) -> &mut WriterBuilder

The escape character to use when writing CSV.

This is only used when double_quote is set to false.

The default value is b'\\'.

pub fn double_quote(&mut self, yes: bool) -> &mut WriterBuilder

The quoting escape mechanism to use when writing CSV.

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

pub fn comment(&mut self, comment: Option<u8>) -> &mut WriterBuilder

The comment character that will be used when later reading the file.

If quote_style is set to QuoteStyle::Necessary, a field will be quoted if the comment character is detected anywhere in the field.

The default value is None.

Trait Implementations

impl Debug for WriterBuilder

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

Formats the value using the given formatter.

impl Default for WriterBuilder

fn default() -> WriterBuilder

Returns the “default value” for a type.