Struct csv_async::Position

pub struct Position { /* private fields */ }

A position in CSV data.

A position is used to report errors in CSV data. All positions include the byte offset, line number and record index at which the error occurred.

Byte offsets and record indices start at 0. Line numbers start at 1.

A CSV reader will automatically assign the position of each record.

Implementations

impl Position

pub fn new() -> Position

Returns a new position initialized to the start value.

pub fn byte(&self) -> u64

The byte offset, starting at 0, of this position.

pub fn line(&self) -> u64

The line number, starting at 1, of this position.

pub fn record(&self) -> u64

The record index, starting with the first record at 0.

pub fn set_byte(&mut self, byte: u64) -> &mut Position

Set the byte offset of this position.

pub fn set_line(&mut self, line: u64) -> &mut Position

Set the line number of this position.

If the line number is less than 1, then this method panics.

pub fn set_record(&mut self, record: u64) -> &mut Position

Set the record index of this position.

Trait Implementations

impl Clone for Position

fn clone(&self) -> Position

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Position

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

Formats the value using the given formatter.

impl Default for Position

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Position

fn eq(&self, other: &Position) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Position

impl StructuralPartialEq for Position