Struct SourceInfo

pub struct SourceInfo { /* private fields */ }

Struct holding the source string and contains helpers to index lines and to query position information from a source string.

Implementations

impl SourceInfo

pub fn new(src: &str) -> Self

Computes the source info from a given string.

pub fn source(&self) -> &str

Returns the entire source.

pub fn count_lines(&self) -> usize

Counts the number of lines in the source string.

pub fn line_span(&self, line: usize) -> Option<Range<usize>>

Gets the character range for the provided line, excluding any whitespace.

This returns None if line is not in the interval [0, number of lines).

pub fn read_line(&self, line: usize) -> Option<&str>

Reads a line from source.

This returns None if line is not in the interval [0, number of lines).

pub fn get_pos_pair(&self, index: usize) -> (usize, usize)

Calculates the line and character number for a given character index.

If the index exceeds the length of the string, the line number is given as the last line and the character number is given as the number of characters after the start of the line.

Trait Implementations

impl Clone for SourceInfo

fn clone(&self) -> SourceInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SourceInfo

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

Formats the value using the given formatter.

impl From<&str> for SourceInfo

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<String> for SourceInfo

fn from(value: String) -> Self

Converts to this type from the input type.

impl PartialEq for SourceInfo

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for SourceInfo

impl StructuralPartialEq for SourceInfo