Struct ZeroCopyByteRecord 

pub struct ZeroCopyByteRecord<'a> { /* private fields */ }

A view of a CSV record into a ZeroCopyReader buffer.

Implementations

impl<'a> ZeroCopyByteRecord<'a>

pub fn len(&self) -> usize

Number of fields of the record. Cannot be less than 1 since a CSV with no columns does not make sense.

pub fn is_empty(&self) -> bool

Returns whether the record has no fields.

pub fn as_slice(&self) -> &[u8]

Returns the underlying byte slice, delimiters and all.

pub fn iter(&self) -> ZeroCopyByteRecordIter<'_>

Returns an iterator over the record’s fields, as-is.

This means fields might or might not be quoted and field bytes have not been unescaped at all.

pub fn unquoted_iter(&self) -> ZeroCopyByteRecordUnquotedIter<'_>

Returns an iterator over the record’s fields, unquoted.

See Self::unquote for more detail.

pub fn unescaped_iter(&self) -> ZeroCopyByteRecordUnescapedIter<'_>

Returns an iterator over the record’s fields, unescaped.

See Self::unescape for more detail.

pub fn get(&self, index: usize) -> Option<&[u8]>

Returns the nth field of the zero copy byte record, if it is not out-of-bounds.

The field’s bytes will be given as-is, quoted or unquoted, and won’t be unescaped at all.

pub fn unquote(&self, index: usize) -> Option<&[u8]>

Returns the nth field of the zero copy byte record, if it is not out-of-bounds.

The field’s bytes will be given unquoted (i.e. without surrounding quotes), but not unescaped (i.e. doubled double quotes will still be there).

The overhead vs. Self::get is only constant (we trim a leading and trailing quote if required).

pub fn unescape(&self, index: usize) -> Option<Cow<'_, [u8]>>

Returns the nth field of the zero copy byte record, if it is not out-of-bounds.

The field’s bytes will be completely unescaped.

The overhead vs. Self::get is linear in the field’s number of bytes.

A Cow::Owned will be returned if the field actually needed unescaping, else a Cow::Borrowed will be returned.

pub fn to_byte_record(&self) -> ByteRecord

Converts the zero copy byte record into a proper, owned ByteRecord.

Trait Implementations

impl Debug for ZeroCopyByteRecord<'_>

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

Formats the value using the given formatter.

impl Index<usize> for ZeroCopyByteRecord<'_>

type Output = [u8]

The returned type after indexing.

fn index(&self, i: usize) -> &[u8]

Performs the indexing (container[index]) operation.