Struct Source 

pub struct Source { /* private fields */ }

A source code object, such as read from a file. Cloning this object results in simply incrementing a reference counter, thus sharing the source code object.

Implementations

impl Source

pub fn new<S0, S1>(name: S0, contents: S1) -> Self

where S0: Into<Box<str>>, S1: Into<Box<str>>,

Creates a new source code object given its name and its contents.

Contents are rearranged as grapheme clusters.

pub fn name(&self) -> &str

The (file) name of the source.

pub fn len(&self) -> usize

The length the source.

pub fn contents(&self) -> &str

The contentss of the source.

pub fn seg_byte_indices(&self) -> SegmentByteIndices<'_>

Iterator over the segment indices of the source, where indices are in terms of bytes.

pub fn newline_indices(&self) -> NewlineIndices<'_>

Iterator over the newline indices of the source, where indices are in terms of segments/grapheme clusters.

pub fn get<I>(&self, indexer: I) -> Option<&I::Output>

where I: SourceIndex,

Indexes this source. It can be a single usize or a range of usize. Indices are given in terms of grapheme clusters/segments.

pub fn full_span(&self) -> Span

Returns a span covering the whole source code.

Trait Implementations

impl Clone for Source

fn clone(&self) -> Source

Returns a duplicate 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 Display for Source

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

Formats the value using the given formatter.

impl Eq for Source

impl Hash for Source

fn hash<H>(&self, hasher: &mut H)

where H: Hasher,

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> Index<I> for Source

where I: SourceIndex,

type Output = <I as SourceIndex>::Output

The returned type after indexing.

fn index(&self, indexer: I) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Ord for Source

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Source

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Source

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.