Struct DelimiterSeparatedTextReadOptions

pub struct DelimiterSeparatedTextReadOptions {
    pub field_delimiter: String,
    pub max_line_size: u64,
    pub quote: String,
    pub header_lines_to_skip: u64,
    pub escape: String,
    pub value_treated_as_null: Option<String>,
}

Delimiter separated files may be compressed. The reader should autodetect this and decompress as needed.

Fields

field_delimiter: String

The character(s) used to separate fields. Common values are comma, tab, and pipe. Multiple characters are allowed.

max_line_size: u64

The maximum number of bytes to read from a single line. If a line exceeds this limit the resulting behavior is undefined.

quote: String

The character(s) used to quote strings. Common values are single and double quotation marks.

header_lines_to_skip: u64

The number of lines to skip at the beginning of the file.

escape: String

The character used to escape characters in strings. Backslash is a common value. Note that a double quote mark can also be used as an escape character but the external quotes should be removed first.

value_treated_as_null: Option<String>

If this value is encountered (including empty string), the resulting value is null instead. Leave unset to disable. If this value is provided, the effective schema of this file is comprised entirely of nullable strings. If not provided, the effective schema is instead made up of non-nullable strings.

Implementations

impl DelimiterSeparatedTextReadOptions

pub fn value_treated_as_null(&self) -> &str

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

Trait Implementations

impl Clone for DelimiterSeparatedTextReadOptions

fn clone(&self) -> DelimiterSeparatedTextReadOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DelimiterSeparatedTextReadOptions

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

Formats the value using the given formatter.

impl Default for DelimiterSeparatedTextReadOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DelimiterSeparatedTextReadOptions

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for DelimiterSeparatedTextReadOptions

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 DelimiterSeparatedTextReadOptions

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

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 DelimiterSeparatedTextReadOptions