pub struct WriterBuilder { /* private fields */ }
Expand description
A CSV writer builder
Implementations§
source§impl WriterBuilder
impl WriterBuilder
sourcepub fn new() -> WriterBuilder
pub fn new() -> WriterBuilder
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
}
sourcepub fn with_header(self, header: bool) -> WriterBuilder
pub fn with_header(self, header: bool) -> WriterBuilder
Set whether to write the CSV file with a header
sourcepub fn with_delimiter(self, delimiter: u8) -> WriterBuilder
pub fn with_delimiter(self, delimiter: u8) -> WriterBuilder
Set the CSV file’s column delimiter as a byte character
sourcepub fn with_quote(self, quote: u8) -> WriterBuilder
pub fn with_quote(self, quote: u8) -> WriterBuilder
Set the CSV file’s quote character as a byte character
sourcepub fn with_escape(self, escape: u8) -> WriterBuilder
pub fn with_escape(self, escape: u8) -> WriterBuilder
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.
sourcepub fn with_double_quote(self, double_quote: bool) -> WriterBuilder
pub fn with_double_quote(self, double_quote: bool) -> WriterBuilder
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).
sourcepub fn double_quote(&self) -> bool
pub fn double_quote(&self) -> bool
Get whether double quote escapes are enabled
sourcepub fn with_date_format(self, format: String) -> WriterBuilder
pub fn with_date_format(self, format: String) -> WriterBuilder
Set the CSV file’s date format
sourcepub fn date_format(&self) -> Option<&str>
pub fn date_format(&self) -> Option<&str>
Get the CSV file’s date format if set, defaults to RFC3339
sourcepub fn with_datetime_format(self, format: String) -> WriterBuilder
pub fn with_datetime_format(self, format: String) -> WriterBuilder
Set the CSV file’s datetime format
sourcepub fn datetime_format(&self) -> Option<&str>
pub fn datetime_format(&self) -> Option<&str>
Get the CSV file’s datetime format if set, defaults to RFC3339
sourcepub fn with_time_format(self, format: String) -> WriterBuilder
pub fn with_time_format(self, format: String) -> WriterBuilder
Set the CSV file’s time format
sourcepub fn time_format(&self) -> Option<&str>
pub fn time_format(&self) -> Option<&str>
Get the CSV file’s datetime time if set, defaults to RFC3339
sourcepub fn with_timestamp_format(self, format: String) -> WriterBuilder
pub fn with_timestamp_format(self, format: String) -> WriterBuilder
Set the CSV file’s timestamp format
sourcepub fn timestamp_format(&self) -> Option<&str>
pub fn timestamp_format(&self) -> Option<&str>
Get the CSV file’s timestamp format if set, defaults to RFC3339
sourcepub fn with_null(self, null_value: String) -> WriterBuilder
pub fn with_null(self, null_value: String) -> WriterBuilder
Set the value to represent null in output
sourcepub fn with_rfc3339(self) -> WriterBuilder
👎Deprecated: Use WriterBuilder::default()
pub fn with_rfc3339(self) -> WriterBuilder
Use RFC3339 format for date/time/timestamps (default)
Trait Implementations§
source§impl Clone for WriterBuilder
impl Clone for WriterBuilder
source§fn clone(&self) -> WriterBuilder
fn clone(&self) -> WriterBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for WriterBuilder
impl Debug for WriterBuilder
source§impl Default for WriterBuilder
impl Default for WriterBuilder
source§fn default() -> WriterBuilder
fn default() -> WriterBuilder
Auto Trait Implementations§
impl Freeze for WriterBuilder
impl RefUnwindSafe for WriterBuilder
impl Send for WriterBuilder
impl Sync for WriterBuilder
impl Unpin for WriterBuilder
impl UnwindSafe for WriterBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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