Struct Splitter 

pub struct Splitter<R> { /* private fields */ }

An already configured CSV record splitter.

Configuration

To configure a Splitter, if you need a custom delimiter for instance of if you want to tweak the size of the inner buffer. Check out the SplitterBuilder.

Implementations

impl<R: Read> Splitter<R>

pub fn from_reader(reader: R) -> Self

Create a new splitter with default configuration using the provided reader implementing std::io::Read.

pub fn has_headers(&self) -> bool

Returns whether this reader has been configured to interpret the first record as a header.

pub fn byte_headers(&mut self) -> Result<&[u8]>

Attempt to return a reference to this splitter’s first record.

pub fn count_records(&mut self) -> Result<u64>

Consume the reader completely to count the number of records as fast as possible.

pub fn split_record(&mut self) -> Result<Option<&[u8]>>

Attempt to split the next CSV record and return an optional reference to its byte slice.

Returns Ok(None) when the reader is fully consumed.

pub fn split_record_with_position(&mut self) -> Result<Option<(u64, &[u8])>>

Attempt to split the next CSV record and return an optional byte offset as well as a reference to its byte slice.

Returns Ok(None) when the reader is fully consumed.

pub fn into_bufreader(self) -> (Option<Vec<u8>>, BufReader<R>)

Unwrap into an optional first record (only when the reader was configured not to interpret the first record as a header, and when the first record was pre-buffered but not yet reemitted), and the underlying BufReader.

pub fn position(&self) -> u64

Returns the current byte offset of the reader in the wrapped stream.

Trait Implementations

impl<R: Debug> Debug for Splitter<R>

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

Formats the value using the given formatter.