Struct source_cache::SourceText

pub struct SourceText { /* private fields */ }

A type representing a single identifier that may be referred to by [Span]s.

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

Implementations

impl SourceText

pub fn snippet<S, N>(text: S, name: N) -> Self

where S: Into<String>, N: Into<Cow<'static, str>>,

Create a snippet with given name

pub fn source_id(&self) -> SourceID

Get the cache id

pub fn get_length(&self) -> usize

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

pub fn get_line(&self, idx: usize) -> Option<&SourceLine>

Get access to a specific, zero-indexed SourceLine.

pub fn get_source(&self) -> &SourcePath

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

pub fn set_source(&mut self, path: SourcePath)

Set path name of identifier

pub fn set_path(&mut self, path: &Path)

Set path name of identifier

pub fn with_path(self, path: &Path) -> Self

Get path name of identifier

pub fn set_remote(&mut self, url: Url) -> bool

Set path name of identifier

pub fn with_remote(self, url: Url) -> Self

Get path name of identifier

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

Return an iterator over the characters in the identifier.

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

Return an iterator over the SourceLines in this identifier.

pub fn clear(&mut self)

Clear the cache cache

impl SourceText

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

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<u32>) -> Range<usize>

Get the range of lines that this source_text runs across.

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

Trait Implementations

impl Clone for SourceText

fn clone(&self) -> SourceText

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SourceText

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

Formats the value using the given formatter.

impl<S: Into<String>> From<S> for SourceText

fn from(source: S) -> Self

Generate a SourceText from the given str.

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

impl Hash for SourceText

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 SourceText

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

impl StructuralPartialEq for SourceText