Struct seq_io::ErrorPosition

pub struct ErrorPosition { /* fields omitted */ }

Position of a parsing error within the file

Implementations

impl ErrorPosition

pub fn new(
    record_pos: Option<Position>,
    err_offset: Option<ErrorOffset>,
    id: Option<String>
) -> Self

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

Returns the exact position, where the error occurred or the record start if there is no specific position. None can be returned if the position is not known because the error occurred in a call to BaseRecord::check_lengths(). Errors returned by any of the readers directly (not record instances) are guaranteed to always have a defined position.

In contrast to the position returned by the function ErrorPosition::record_position(), an optional ErrorOffset is applied to the sequence record position (see ErrorPosition::error_offset()) to obtain the exact line and byte position of the error.

pub fn record_id(&self) -> Option<&str>

Returns the ID of the record where the error occurred, if available. If parsing already failed within the sequence header, None is returned. Invalid UTF-8 bytes are replaced (see String::from_utf8_lossy).

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

Returns a reference to the Position describing the line and byte offset of the sequence record, where the error occurred (if known, see position()).

pub fn error_offset(&self) -> Option<&ErrorOffset>

Returns the offset (line / byte) from the record start, at which the error occurred, if available.

Trait Implementations

impl Clone for ErrorPosition

fn clone(&self) -> ErrorPosition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorPosition

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

Formats the value using the given formatter.

impl Default for ErrorPosition

fn default() -> ErrorPosition

Returns the "default value" for a type.

impl Display for ErrorPosition

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

Formats the value using the given formatter.

impl Eq for ErrorPosition

impl PartialEq<ErrorPosition> for ErrorPosition

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

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

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

This method tests for !=.

impl StructuralEq for ErrorPosition

impl StructuralPartialEq for ErrorPosition