Struct csv_core::ReaderBuilder

[+] Show declaration

pub struct ReaderBuilder { /* fields omitted */ }

[−] Expand description

Builds a CSV reader with various configuration knobs.

This builder can be used to tweak the field delimiter, record terminator and more for parsing CSV. Once a CSV Reader is built, its configuration cannot be changed.

Implementations

impl ReaderBuilder[−]

pub fn new() -> ReaderBuilder[−]

Create a new builder.

pub fn build(&self) -> Reader[−]

Build a CSV parser from this configuration.

pub fn delimiter(&mut self, delimiter: u8) -> &mut ReaderBuilder[−]

The field delimiter to use when parsing CSV.

The default is b','.

pub fn terminator(&mut self, term: Terminator) -> &mut ReaderBuilder[−]

The record terminator to use when parsing CSV.

A record terminator can be any single byte. The default is a special value, Terminator::CRLF, which treats any occurrence of \r, \n or \r\n as a single record terminator.

pub fn quote(&mut self, quote: u8) -> &mut ReaderBuilder[−]

The quote character to use when parsing CSV.

The default is b'"'.

pub fn escape(&mut self, escape: Option<u8>) -> &mut ReaderBuilder[−]

The escape character to use when parsing CSV.

In some variants of CSV, quotes are escaped using a special escape character like \ (instead of escaping quotes by doubling them).

By default, recognizing these idiosyncratic escapes is disabled.

pub fn double_quote(&mut self, yes: bool) -> &mut ReaderBuilder[−]

Enable double quote escapes.

This is enabled by default, but it may be disabled. When disabled, doubled quotes are not interpreted as escapes.

pub fn quoting(&mut self, yes: bool) -> &mut ReaderBuilder[−]

Enable or disable quoting.

This is enabled by default, but it may be disabled. When disabled, quotes are not treated specially.

pub fn comment(&mut self, comment: Option<u8>) -> &mut ReaderBuilder[−]

The comment character to use when parsing CSV.

If the start of a record begins with the byte given here, then that line is ignored by the CSV parser.

This is disabled by default.

pub fn ascii(&mut self) -> &mut ReaderBuilder[−]

A convenience method for specifying a configuration to read ASCII delimited text.

This sets the delimiter and record terminator to the ASCII unit separator (\x1F) and record separator (\x1E), respectively.

Trait Implementations

impl Debug for ReaderBuilder[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Default for ReaderBuilder[+]

[+] Show hidden undocumented items

fn default() -> ReaderBuilder[−]

Returns the “default value” for a type.