Struct CsvOptions 

pub struct CsvOptions {
    pub trim: Option<bool>,
    pub comment: Option<bool>,
    pub number: Option<bool>,
    pub value: Option<bool>,
    pub header: bool,
    pub object: bool,
    pub strict: bool,
    pub field: FieldOptions,
    pub record: RecordOptions,
    pub string: StringOptions,
    pub stream: Option<Stream>,
}

The plugin options: the counterpart of the TypeScript CsvOptions and Csv.defaults, and of the Go Defaults map. Default is the documented default set.

The three-state options (trim, comment, number, value) are Option<bool>: None is the TypeScript null, which means “off in strict mode, on in non-strict mode”.

Fields

trim: Option<bool>

Drop the whitespace around an unquoted field.

comment: Option<bool>

Lex # comments, so a comment line is no record and a trailing comment is not field text.

number: Option<bool>

Lex numbers, so 1e2 is the number 100 rather than text.

value: Option<bool>

Lex the value keywords, so true, false and null are values rather than text.

header: bool

The first row names the columns.

object: bool

Each record is an object keyed by column name; false gives an array of field values.

strict: bool

Every field is raw text. false lets a field body hold embedded jsonic ([1,2], {x:1}, a backslash-escaped string) and turns trim, comment, number and value on unless set.

field: FieldOptions

Field options.

record: RecordOptions

Record options.

string: StringOptions

String options.

stream: Option<Stream>

Stream records to a callback instead of collecting them. A closure cannot travel in the plugin option bag, so it is carried here, outside serialization, and reaches the plugin through plugin_with and make_with.

Implementations

impl CsvOptions

pub fn from_value(value: &Value) -> Result<Self, String>

Read options out of a plugin option bag, the form Tabnas::use_plugin merges and hands to the plugin. A missing key takes its default; an unknown key is ignored, as in the other two runtimes.

pub fn to_value(&self) -> Value

The options as a plugin option bag, the form Plugin::with_defaults and Tabnas::use_plugin take. The stream callback does not travel; see plugin_with.

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

where CsvOptions: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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.