Struct CsvOptions 

pub struct CsvOptions {
    pub delimiter: String,
    pub has_headers: bool,
    pub quote: String,
    pub flexible: Option<bool>,
    pub null_values: Vec<String>,
    pub on_unknown_field: CsvUnknownField,
}

CSV dialect.

Fields

delimiter: String

Field separator. A single character; "\t" is accepted for tabs.

has_headers: bool

Whether the first row names the fields. When false, fields are named column_0, column_1, … — the same fallback the REST source and the csv connector already use. On write it decides whether a header row is written; write_headers is accepted as another name for it.

quote: String

Quote character. A single byte; default ".

flexible: Option<bool>

Whether rows may have a different number of fields than the header. false fails the read on the first ragged row, naming its line; true keeps the fields the row has. Unset, each connector picks: the file source is strict, the object-store sources and the REST source are lenient.

null_values: Vec<String>

Cell values read as null instead of a string (e.g. ["", "NULL"]).

on_unknown_field: CsvUnknownField

What a streaming CSV writer does with a field the header does not have. See CsvUnknownField. Whole-object encoders always write the union of every record’s fields, so it only affects the file sink.

Implementations

impl CsvOptions

pub fn delimiter_byte(&self) -> Result<u8, FaucetError>

The delimiter as the single byte the CSV readers want.

Rejected rather than truncated: a multi-byte delimiter silently becoming its first byte would split every row in the wrong place and produce plausible-looking garbage.

pub fn quote_byte(&self) -> Result<u8, FaucetError>

The quote character as a single byte.

pub fn flexible_or(&self, default: bool) -> bool

Whether ragged rows are accepted, with default when unset.

pub fn validate(&self) -> Result<(), FaucetError>

Check the single-byte fields, so a bad dialect fails at load time.

Trait Implementations

impl Clone for CsvOptions

fn clone(&self) -> Self

Returns a duplicate 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

Formats the value using the given formatter.

impl Default for CsvOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CsvOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CsvOptions

impl JsonSchema for CsvOptions

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for CsvOptions

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CsvOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CsvOptions