Struct SrcRef 

pub struct SrcRef {
    pub range: Span,
    pub at: LineCol,
    pub source_hash: HashId,
}

Reference into a source file.

Hint: Source file is not part of SrcRef and must be provided from outside

Fields

range: Span

Range in bytes

at: LineCol

Line and column

source_hash: HashId

Hash of the source code file to map SrcRef -> SourceFile

Implementations

impl SrcRef

pub fn new(range: Range<usize>, at: LineCol, source_hash: HashId) -> Self

Create new SrcRef

• range: Position in file
• line: Line number within file
• col: Column number within file

pub fn none() -> Self

pub fn as_miette_span(&self) -> Option<SourceSpan>

Return a span for the source reference as expected by miette

pub fn is_none(&self) -> bool

pub fn is_some(&self) -> bool

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

Check if two source refs are overlapping.

This means they must have the same non-zero source file hash and its ranges must overlap.

pub fn with_line_offset(&self, line_offset: u32) -> Self

Return a reference with a given line offset.

pub fn len(&self) -> usize

return length of SrcRef

pub fn is_empty(&self) -> bool

return true if code base is empty

pub fn source_hash(&self) -> u64

return source file hash

• 0 if not SrcRefInner is none
• u64 if SrcRefInner is some

This is used to map SrcRef -> SourceFile

pub fn source_slice<'a>(&self, src: &'a str) -> &'a str

Return slice to code base.

pub fn merge(lhs: &impl SrcReferrer, rhs: &impl SrcReferrer) -> SrcRef

Merge two SrcRef into a single one.

SrcRef::none() is returned if:

• ranges not in correct order (warning in log),
• references are not in the same file (warning in log),
• or lhs and rhs are both None.

pub fn merge_all<S: SrcReferrer>(referrers: impl Iterator<Item = S>) -> SrcRef

Merge all given source references to one

All given source references must have the same hash otherwise panics!

pub fn at(&self) -> Option<LineCol>

Return line and column in source code or None if not available.

pub fn line(&self) -> Option<u32>

Get the line of the start of the referenced source, if any

pub fn col(&self) -> Option<u32>

Get the column of the start of the referenced source, if any

Trait Implementations

impl Clone for SrcRef

fn clone(&self) -> SrcRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SrcRef

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

Formats the value using the given formatter.

impl Default for SrcRef

fn default() -> SrcRef

Returns the “default value” for a type.

impl Display for SrcRef

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

Formats the value using the given formatter.

impl Eq for SrcRef

impl From<SrcRef> for SourceSpan

fn from(value: SrcRef) -> Self

Converts to this type from the input type.

impl Ord for SrcRef

fn cmp(&self, _: &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 SrcRef

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SrcRef

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.

impl SrcReferrer for SrcRef

We want to be able to use SrcRef directly in functions with impl SrcReferrer argument

fn src_ref(&self) -> SrcRef

Return source code reference.

fn source_hash(&self) -> u64

Return source code hash.