Struct Source

pub struct Source { /* private fields */ }

A type representing a single source that may be referred to by Spans.

In most cases, a source is a single input file.

Implementations

impl Source

pub fn length(&self) -> usize

Get the length of the total number of characters in the source.

pub fn chars(&self) -> impl Iterator<Item = char> + '_

Return an iterator over the characters in the source.

pub fn line(&self, idx: usize) -> Option<&Line>

Get access to a specific, zero-indexed Line.

pub fn lines(&self) -> impl ExactSizeIterator<Item = &Line> + '_

Return an iterator over the Lines in this source.

pub fn get_offset_line(&self, offset: usize) -> Option<(&Line, usize, usize)>

Get the line that the given offset appears on, and the line/column numbers of the offset.

Note that the line/column numbers are zero-indexed.

pub fn get_line_range(&self, span: &Range<usize>) -> Range<usize>

Get the range of lines that this span runs across.

The resulting range is guaranteed to contain valid line indices (i.e: those that can be used for Source::line).

Trait Implementations

impl Clone for Source

fn clone(&self) -> Source

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Source

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

Formats the value using the given formatter.

impl<S: AsRef<str>> From<S> for Source

fn from(s: S) -> Self

Generate a Source from the given str.

Note that this function can be expensive for long strings. Use an implementor of [Cache] where possible.

impl Hash for Source

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Source

fn eq(&self, other: &Source) -> 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 Source

impl StructuralPartialEq for Source