Struct ByteRecord 

pub struct ByteRecord { /* private fields */ }

An owned, unquoted/unescaped representation of a CSV record.

ByteRecord are typically used with a Reader.

Creating a ByteRecord:

use simd_csv::ByteRecord;

let mut record = ByteRecord::new();
record.push_field(b"john");
record.push_field(b"landis");

Implementations

impl ByteRecord

pub fn new() -> Self

Create a empty record.

pub fn len(&self) -> usize

Return the number of fields of the record.

pub fn is_empty(&self) -> bool

Return whether the record is empty.

pub fn clear(&mut self)

Clear the record completely.

pub fn truncate(&mut self, len: usize)

Shortens the record, keeping the first len elements and dropping the rest.

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

Return the underlying byte slice.

BEWARE: the Reader amortizes copies by sometimes including spurious data such as quotes and delimiters. You will never see those bytes while accessing fields because the field boundaries remain correct, but you will see them in the underlying slice.

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

Return an iterator over the record’s fields.

pub fn push_field(&mut self, bytes: &[u8])

Append a new field to the back of the record.

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

Return field at index. Will return None if index is out of bounds.

Trait Implementations

impl Clone for ByteRecord

fn clone(&self) -> ByteRecord

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ByteRecord

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

Formats the value using the given formatter.

impl Default for ByteRecord

fn default() -> ByteRecord

Returns the “default value” for a type.

impl<T: AsRef<[u8]>> Extend<T> for ByteRecord

fn extend<I: IntoIterator<Item = T>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<I, T> From<I> for ByteRecord

where I: IntoIterator<Item = T>, T: AsRef<[u8]>,

fn from(value: I) -> Self

Converts to this type from the input type.

impl<T: AsRef<[u8]>> FromIterator<T> for ByteRecord

fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self

Creates a value from an iterator.

impl Hash for ByteRecord

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Index<usize> for ByteRecord

type Output = [u8]

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<'r> IntoIterator for &'r ByteRecord

type IntoIter = ByteRecordIter<'r>

Which kind of iterator are we turning this into?

type Item = &'r [u8]

The type of the elements being iterated over.

fn into_iter(self) -> ByteRecordIter<'r>

Creates an iterator from a value.

impl PartialEq for ByteRecord

fn eq(&self, other: &Self) -> 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 Eq for ByteRecord