Struct ariadne::Source

source ·
pub struct Source<I: AsRef<str> = String> { /* private fields */ }
Expand description

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

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

Implementations§

source§

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

source

pub fn len(&self) -> usize

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

source

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

Return an iterator over the characters in the source.

source

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

Get access to a specific, zero-indexed Line.

source

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

Return an iterator over the Lines in this source.

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.

source

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).

source

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

Get the source text for a line, excluding trailing whitespace.

Trait Implementations§

source§

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

§

type Storage = I

The type used to store the string data for this cache. Read more
source§

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

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

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

Display the given ID. as a single inline value. Read more
source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

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.

source§

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

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

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

source§

fn eq(&self, other: &Source<I>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

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

source§

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

Auto Trait Implementations§

§

impl<I> RefUnwindSafe for Source<I>
where I: RefUnwindSafe,

§

impl<I> Send for Source<I>
where I: Send,

§

impl<I> Sync for Source<I>
where I: Sync,

§

impl<I> Unpin for Source<I>
where I: Unpin,

§

impl<I> UnwindSafe for Source<I>
where I: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.