Struct sleek_csv::byte_arena::ByteRecordArena

pub struct ByteRecordArena { /* fields omitted */ }

Implementations

impl ByteRecordArena

pub fn new() -> ByteRecordArena

pub fn with_headers(headers: Headers) -> ByteRecordArena

pub fn record_count(&self) -> u64

Returns the amount of full records. A possible partial record isn't included in the count.

pub fn is_partial(&self) -> bool

Tells if ByteRecordArea contains a partial record. If either of field_data or field_ends contains items that isn't contained in a full record indicated by record_ends, the arena is considered to contain a partial record.

pub fn is_empty(&self) -> bool

Tells if ByteRecordArena is empty i.e. it doesn't contain any input information. This includes:

1. doesn't contain any header information
2. doesn't contain any records However, it doesn't mean that the arena is in a "freshly initialized" state; it might contain a non-zero starting position or headers.

pub fn is_pristine(&self) -> bool

Tells if ByteRecordArena is in the "freshly initialized" state i.e. it hasn't got any input information. This includes:

1. doesn't contain any header information
2. doesn't contain any records
3. doesn't contain partial records
4. doesn't have starting position other than 0. However, it doesn't take into account some purely internal properties that have only diminishingly small performance effects. These properties include the internal capacity of the storage fields and the info whether they have been zeroed or contain undefined bytes.

pub fn migrate_partial(&mut self, other: &mut ByteRecordArena) -> (usize, usize)

Migrates the partial data over another arena. All data, including the partial record, on the other arena is deleted. Returns partial data length and partial field count.

pub fn flush(&mut self) -> (usize, usize)

Deletes all records except the partial record. The user is expected to continue reading the partial record. Sets the start position anew, to be set again by Reader.

pub fn clear(&mut self)

Deletes all records including the partial record. TODO: decide what to do with headers and start up position

pub fn headers(&self) -> Option<&Headers>

pub fn start_pos(&self) -> Option<&Position>

pub fn expose_data(&mut self) -> &mut [u8]

pub fn terminate_field(&mut self, field_size: usize)

pub fn terminate_record(&mut self)

pub fn reserve_space(&mut self, data: usize)

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

pub fn complete_partial(&mut self)

Trait Implementations

impl Debug for ByteRecordArena

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

Formats the value using the given formatter.