Struct ariadne::Source

pub struct Source<I: AsRef<str> = String> { /* 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<I: AsRef<str>> Source<I>

pub fn text(&self) -> &str

Get the full text of this source file.

impl<I: AsRef<str>> Source<I>

pub fn len(&self) -> usize

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

pub fn is_empty(&self) -> bool

Returns true if this source contains no characters.

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_byte_line(&self, byte_offset: usize) -> Option<(Line, usize, usize)>

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

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

pub fn get_line_range<S: Span>(&self, span: &S) -> 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).

pub fn get_line_text(&self, line: Line) -> Option<&str>

Get the source text for a line, includes trailing whitespace and the newline

Trait Implementations

impl<I: AsRef<str>> Cache<()> for Source<I>

type Storage = I

The type used to store the string data for this cache.

fn fetch(&mut self, _: &()) -> Result<&Source<I>, Box<dyn Debug + '_>>

Fetch the Source identified by the given ID, if possible.

fn display(&self, _: &()) -> Option<Box<dyn Display>>

Display the given ID. as a single inline value.

impl<I: Clone + AsRef<str>> Clone for Source<I>

fn clone(&self) -> Source<I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I: Debug + AsRef<str>> Debug for Source<I>

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

Formats the value using the given formatter.

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

fn from(input: I) -> 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<I: Hash + AsRef<str>> Hash for Source<I>

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<I: PartialEq + AsRef<str>> PartialEq for Source<I>

fn eq(&self, other: &Source<I>) -> 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<I: Eq + AsRef<str>> Eq for Source<I>

impl<I: AsRef<str>> StructuralPartialEq for Source<I>