Struct SourceSpan 

pub struct SourceSpan { /* private fields */ }

Represents a range of bytes in a specific source file

A SourceSpan is a combination of SourceId and a range of byte indices in the corresponding file. With one, you may obtain a variety of useful information about the source to which it maps using the CodeMap from which it was created:

• Can be used to get a str of the original file content containing just the specified range.
• Can be used to get file/line/column at which the span starts
• Can be used to get the [SourceFile] from which it is derived

A SourceSpan has a canonical “default” value, which is represented by SourceSpan::UNKNOWN. It can be treated like a regular span, however when a request is made for content or location information corresponding to it, those APIs will return None or Err. This is useful when constructing syntax trees and the like without sources, such as in testing scenarios.

Implementations

impl SourceSpan

pub const UNKNOWN: Self

Represents an invalid/unknown source location

pub fn new(start: SourceIndex, end: SourceIndex) -> Self

Creates a new span from start to end

This function will panic if the indices are in different source files

pub fn is_unknown(self) -> bool

Returns true if this span represents an “unknown” source span

pub fn source_id(&self) -> SourceId

Returns the SourceId associated with this span

pub fn start(&self) -> SourceIndex

Returns the starting SourceIndex of this span

pub fn start_index(&self) -> ByteIndex

Returns the starting ByteIndex of this span in its [SourceFile]

pub fn shrink_front(self, offset: ByteOffset) -> Self

Shrinks this span by truncating offset bytes from the start of its range

pub fn end(&self) -> SourceIndex

Returns the ending source index of this span

pub fn end_index(&self) -> ByteIndex

Returns the ending byte index of this span in its SourceFile

pub fn merge(self, other: SourceSpan) -> Option<SourceSpan>

Creates a new span that covers both this span and other, forming a new contiguous span

Returns None if either span is invalid or from a different source file.

The order of the spans is not important.

Trait Implementations

impl Clone for SourceSpan

fn clone(&self) -> SourceSpan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SourceSpan

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

Formats the value using the given formatter.

impl Default for SourceSpan

fn default() -> Self

Returns the “default value” for a type.

impl From<SourceSpan> for ByteIndex

fn from(span: SourceSpan) -> Self

Converts to this type from the input type.

impl From<SourceSpan> for Range<SourceIndex>

fn from(span: SourceSpan) -> Range<SourceIndex>

Converts to this type from the input type.

impl From<SourceSpan> for Range<usize>

fn from(span: SourceSpan) -> Range<usize>

Converts to this type from the input type.

impl From<SourceSpan> for Span

fn from(span: SourceSpan) -> Self

Converts to this type from the input type.

impl Hash for SourceSpan

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 Ord for SourceSpan

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

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

fn partial_cmp(&self, other: &SourceSpan) -> 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.

impl Spanned for SourceSpan

fn span(&self) -> SourceSpan

impl Copy for SourceSpan

impl Eq for SourceSpan

impl StructuralPartialEq for SourceSpan