Struct LineCursor 

pub struct LineCursor { /* private fields */ }

LineCursor

A line cursor type of a parser that holds the start line and offset from it. The relative offset cursor is used to actually access the source lines’ contents, whereas the sum of relative and absolute cursors is used mainly for debug prints and|or error messages.

Implementations

impl LineCursor

pub fn new(relative: Line, absolute: Line) -> Self

A LineCursor constructor.

pub fn relative_offset(&self) -> Line

Retrieves the line relative to the baseline that a (nested) parser is on.

pub fn relative_offset_mut_ref(&mut self) -> &mut Line

Retrieves a mutable reference to the line that the (nested) parser is on.

pub fn increment_by(&mut self, amount: Line)

Increments relative offset by given amount.

pub fn sum_total(&self) -> Line

Returns the sum total of self.relative_offset and *self.baseline.

Trait Implementations

impl Debug for LineCursor

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

Formats the value using the given formatter.