Struct asciifile::line_number_cache::LineNumberCache

pub struct LineNumberCache { /* fields omitted */ }

Methods

impl LineNumberCache

pub fn new(linebreaks: Vec<usize>) -> Self

Return a LineNumberCache with UNIX-style line breaks (single \n byte) at byte offsets given in linebreaks.

pub fn line_number(&self, byte_offset: usize) -> usize

Return the line number at byte_offset. Identical to row() + 1.

This does not detect errors caused by byte_offsets that are out of range. Prefer the safe API of the Position struct instead.

pub fn column(&self, byte_offset: usize) -> usize

Return the column of the characters position within the file.

The column is zero based, meaning the first characters of a line/row is positioned at column 0.

This does not detect errors caused by byte_offsets that are out of range. Prefer the safe API of the Position struct instead.

pub fn row(&self, byte_offset: usize) -> usize

Return the row of the character's position within the file.

This does not detect errors caused by byte_offsets that are out of range. Prefer the safe API of the Position struct instead.

pub fn row_and_column(&self, byte_offset: usize) -> (usize, usize)

Get row and column at once. Equivalent to calling row(&self, byte_offset: usize) and column(&self, byte_offset: usize).

This method exists because most of the time you want both. And it's more efficient to look up both at once.

This does not detect errors caused by byte_offsets that are out of range. Prefer the safe API of the Position struct instead.

Trait Implementations

impl Debug for LineNumberCache

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

Formats the value using the given formatter.