Struct CsvStreamFormat 

pub struct CsvStreamFormat { /* private fields */ }

Available on crate feature csv only.

CSV rows, with an optional header row.

Implementations

impl CsvStreamFormat

pub fn new(has_headers: bool, delimiter: u8) -> Self

CSV with the given header behaviour and field delimiter, everything else default.

pub fn with_flexible(self, flexible: bool) -> Self

Sets whether to use flexible serialize.

Encode only. On the way back in, records are framed and deserialised one at a time, so there is no “first record” to compare a field count against. That was already true of the previous decoder, where a fresh reader was built per row.

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

Sets the quote style to use.

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

Sets the quote character to use.

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

Sets whether to double quote.

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

Sets the escape character to use.

pub fn with_terminator(self, terminator: Terminator) -> Self

Sets the record terminator to use.

Honoured in both directions: the framer is configured from the same value.

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

Set the field delimiter to use.

pub fn with_has_headers(self, has_headers: bool) -> Self

Set whether to write headers.

Trait Implementations

impl Clone for CsvStreamFormat

fn clone(&self) -> CsvStreamFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CsvStreamFormat

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

Formats the value using the given formatter.

impl Default for CsvStreamFormat

fn default() -> Self

Returns the “default value” for a type.

impl DefaultFormat for CsvStreamFormat

fn default_format() -> Self

The configuration to use when the caller supplied none.

impl StreamFormat for CsvStreamFormat

fn format_name(&self) -> &'static str

A short, stable name, reported as the format tracing field.

fn default_content_type(&self) -> &'static str

The Content-Type this format emits when encoding.

fn accepts_content_type(&self, ct: &ContentType<'_>) -> bool

Whether an incoming Content-Type should be accepted as this format.

impl<T> StreamFormatDecode<T> for CsvStreamFormat

where T: for<'de> Deserialize<'de>,

type Frame = ByteRecord

One framed record, before deserialisation.

type Framer = CsvRecordCodec

Splits the body into records.

type Parser = CsvParser

Deserialises framed records.

fn framer(&self, options: &DecodeOptions) -> Self::Framer

Build a framer for one body.

fn parser(&self) -> Self::Parser

Build a parser for one body.

impl<T> StreamFormatEncode<T> for CsvStreamFormat

where T: Serialize,

type Encoder = CsvEncoder

The per-stream encoder. A fresh one is built for every body, because framing state (item index, Arrow’s dictionary tracker, CSV’s header flag) is per-stream.

fn encoder(&self) -> Self::Encoder

Build an encoder for one body.