Struct EncoderBuilder

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

Helper for constructing a CSV Encoder.

No fields are required.

Implementations

impl<W> EncoderBuilder<W>

where W: Write,

pub fn new(writer: W) -> Self

Creates a new CSV encoder builder.

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

Sets whether the CSV encoder will serialize price fields as a decimal. Defaults to false.

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

Sets whether the CSV encoder will serialize timestamp fields as ISO8601 datetime strings. Defaults to false.

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

Sets whether the CSV encoder will write a header row automatically. Defaults to true.

If false, a header row can still be written with Encoder::encode_header() or Encoder::encode_header_for_schema().

pub fn schema(self, schema: Option<Schema>) -> Self

Sets the schema that will be encoded, used for determining the header row to write.

If schema isn’t set and write_header is left enabled, the header will be written based on the type of the first record.

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

Sets whether to add a header field “ts_out”. Defaults to false.

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

Sets whether to add a header field “symbol”. Defaults to false.

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

Sets the field delimiter. Defaults to b',' for comma-separated values (CSV).

pub fn build(self) -> Result<Encoder<W>>

Creates the new encoder with the previously specified settings and if write_header is true, encodes the header row.

Errors

This function returns an error if it fails to write the header row.