Struct CsvInputBuilder

#[non_exhaustive]
pub struct CsvInputBuilder { /* private fields */ }

A builder for CsvInput.

Implementations

impl CsvInputBuilder

pub fn file_header_info(self, input: FileHeaderInfo) -> Self

Describes the first line of input. Valid values are:

• NONE: First line is not a header.

• IGNORE: First line is a header, but you can't use the header values to indicate the column in an expression. You can use column position (such as _1, _2, …) to indicate the column (SELECT s._1 FROM OBJECT s).

• Use: First line is a header, and you can use the header value to identify a column in an expression (SELECT "name" FROM OBJECT).

pub fn set_file_header_info(self, input: Option<FileHeaderInfo>) -> Self

Describes the first line of input. Valid values are:

• NONE: First line is not a header.

• IGNORE: First line is a header, but you can't use the header values to indicate the column in an expression. You can use column position (such as _1, _2, …) to indicate the column (SELECT s._1 FROM OBJECT s).

• Use: First line is a header, and you can use the header value to identify a column in an expression (SELECT "name" FROM OBJECT).

pub fn get_file_header_info(&self) -> &Option<FileHeaderInfo>

Describes the first line of input. Valid values are:

• NONE: First line is not a header.

• IGNORE: First line is a header, but you can't use the header values to indicate the column in an expression. You can use column position (such as _1, _2, …) to indicate the column (SELECT s._1 FROM OBJECT s).

• Use: First line is a header, and you can use the header value to identify a column in an expression (SELECT "name" FROM OBJECT).

pub fn comments(self, input: impl Into<String>) -> Self

A single character used to indicate that a row should be ignored when the character is present at the start of that row. You can specify any character to indicate a comment line. The default character is #.

Default: #

pub fn set_comments(self, input: Option<String>) -> Self

A single character used to indicate that a row should be ignored when the character is present at the start of that row. You can specify any character to indicate a comment line. The default character is #.

Default: #

pub fn get_comments(&self) -> &Option<String>

A single character used to indicate that a row should be ignored when the character is present at the start of that row. You can specify any character to indicate a comment line. The default character is #.

Default: #

pub fn quote_escape_character(self, input: impl Into<String>) -> Self

A single character used for escaping the quotation mark character inside an already escaped value. For example, the value """ a , b """ is parsed as " a , b ".

pub fn set_quote_escape_character(self, input: Option<String>) -> Self

A single character used for escaping the quotation mark character inside an already escaped value. For example, the value """ a , b """ is parsed as " a , b ".

pub fn get_quote_escape_character(&self) -> &Option<String>

A single character used for escaping the quotation mark character inside an already escaped value. For example, the value """ a , b """ is parsed as " a , b ".

pub fn record_delimiter(self, input: impl Into<String>) -> Self

A single character used to separate individual records in the input. Instead of the default value, you can specify an arbitrary delimiter.

pub fn set_record_delimiter(self, input: Option<String>) -> Self

A single character used to separate individual records in the input. Instead of the default value, you can specify an arbitrary delimiter.

pub fn get_record_delimiter(&self) -> &Option<String>

A single character used to separate individual records in the input. Instead of the default value, you can specify an arbitrary delimiter.

pub fn field_delimiter(self, input: impl Into<String>) -> Self

A single character used to separate individual fields in a record. You can specify an arbitrary delimiter.

pub fn set_field_delimiter(self, input: Option<String>) -> Self

A single character used to separate individual fields in a record. You can specify an arbitrary delimiter.

pub fn get_field_delimiter(&self) -> &Option<String>

A single character used to separate individual fields in a record. You can specify an arbitrary delimiter.

pub fn quote_character(self, input: impl Into<String>) -> Self

A single character used for escaping when the field delimiter is part of the value. For example, if the value is a, b, Amazon S3 wraps this field value in quotation marks, as follows: " a , b ".

Type: String

Default: "

Ancestors: CSV

pub fn set_quote_character(self, input: Option<String>) -> Self

A single character used for escaping when the field delimiter is part of the value. For example, if the value is a, b, Amazon S3 wraps this field value in quotation marks, as follows: " a , b ".

Type: String

Default: "

Ancestors: CSV

pub fn get_quote_character(&self) -> &Option<String>

A single character used for escaping when the field delimiter is part of the value. For example, if the value is a, b, Amazon S3 wraps this field value in quotation marks, as follows: " a , b ".

Type: String

Default: "

Ancestors: CSV

pub fn allow_quoted_record_delimiter(self, input: bool) -> Self

Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance.

pub fn set_allow_quoted_record_delimiter(self, input: Option<bool>) -> Self

Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance.

pub fn get_allow_quoted_record_delimiter(&self) -> &Option<bool>

Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance.

pub fn build(self) -> CsvInput

Consumes the builder and constructs a CsvInput.

Trait Implementations

impl Clone for CsvInputBuilder

fn clone(&self) -> CsvInputBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CsvInputBuilder

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

Formats the value using the given formatter.

impl Default for CsvInputBuilder

fn default() -> CsvInputBuilder

Returns the “default value” for a type.

impl PartialEq for CsvInputBuilder

fn eq(&self, other: &CsvInputBuilder) -> 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 StructuralPartialEq for CsvInputBuilder