Struct ion_rs::result::Position

pub struct Position { /* private fields */ }

Position represents the location within an Ion stream where an error has been identified. For all formats byte_offset will contain the number of bytes into the stream that have been processed prior to encountering the error. When working with the text format, line_column will be updated to contain the line and column as well.

Implementations

impl Position

pub fn with_offset(offset: usize) -> Self

Creates a new Position with the provided offset in bytes. Line and Column offsets can be added using Self::with_text_position().

pub fn with_text_position(&self, line: usize, column: usize) -> Self

Add line and column information to the current Position.

pub fn byte_offset(&self) -> usize

Returns the offset from the start of the Ion stream in bytes.

pub fn text_position(&self) -> Option<(usize, usize)>

If available returns the text position as line and column offsets.

pub fn line(&self) -> Option<usize>

If available returns the line component of the text position.

pub fn column(&self) -> Option<usize>

If available returns the column component of the text position.

pub fn has_text_position(&self) -> bool

Returns true if the current Position contains line and column offsets.

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 Display for Position

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

Formats the value using the given formatter.

impl PartialEq<Position> 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 StructuralEq for Position

impl StructuralPartialEq for Position