Struct CsvOptions

pub struct CsvOptions {

    pub has_header: Vec<u8>,
    pub delimiter: Vec<u8>,
    pub quote: Vec<u8>,
    pub escape: Vec<u8>,
    pub compression: i32,
    pub schema_infer_max_rec: Option<u64>,
    pub date_format: String,
    pub datetime_format: String,
    pub timestamp_format: String,
    pub timestamp_tz_format: String,
    pub time_format: String,
    pub null_value: String,
    pub null_regex: String,
    pub comment: Vec<u8>,
    pub double_quote: Vec<u8>,
    pub newlines_in_values: Vec<u8>,
    pub terminator: Vec<u8>,
}

Options controlling CSV format

Fields

has_header: Vec<u8>

Indicates if the CSV has a header row

delimiter: Vec<u8>

Delimiter character as a byte

quote: Vec<u8>

Quote character as a byte

escape: Vec<u8>

Optional escape character as a byte

compression: i32

Compression type

schema_infer_max_rec: Option<u64>

Optional max records for schema inference

date_format: String

Optional date format

datetime_format: String

Optional datetime format

timestamp_format: String

Optional timestamp format

timestamp_tz_format: String

Optional timestamp with timezone format

time_format: String

Optional time format

null_value: String

Optional representation of null value

null_regex: String

Optional representation of null loading regex

comment: Vec<u8>

Optional comment character as a byte

double_quote: Vec<u8>

Indicates if quotes are doubled

newlines_in_values: Vec<u8>

Indicates if newlines are supported in values

terminator: Vec<u8>

Optional terminator character as a byte

Implementations

impl CsvOptions

pub fn compression(&self) -> CompressionTypeVariant

Returns the enum value of compression, or the default if the field is set to an invalid enum value.

pub fn set_compression(&mut self, value: CompressionTypeVariant)

Sets compression to the provided enum value.

pub fn schema_infer_max_rec(&self) -> u64

Returns the value of schema_infer_max_rec, or the default value if schema_infer_max_rec is unset.

Trait Implementations

impl Clone for CsvOptions

fn clone(&self) -> CsvOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CsvOptions

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

Formats the value using the given formatter.

impl Default for CsvOptions

fn default() -> CsvOptions

Returns the “default value” for a type.

impl Message for CsvOptions

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for CsvOptions

fn eq(&self, other: &CsvOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&CsvOptions> for CsvOptions

type Error = DataFusionError

The type returned in the event of a conversion error.

fn try_from( opts: &CsvOptions, ) -> Result<CsvOptions, <CsvOptions as TryFrom<&CsvOptions>>::Error>

Performs the conversion.

impl StructuralPartialEq for CsvOptions