Struct SrcRef 

pub struct SrcRef(pub Option<Box<SrcRefInner>>);

Reference into a source file.

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

Tuple Fields

0: Option<Box<SrcRefInner>>

Implementations

impl SrcRef

pub fn new( range: Range<usize>, line: usize, col: usize, source_file_hash: u64, ) -> Self

Create new SrcRef

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

impl SrcRef

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 is_overlapping(&self, other: &Self) -> bool

Returns true two source code references overlap.

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

Methods from Deref<Target = Option<Box<SrcRefInner>>>

pub fn is_some(&self) -> bool

Returns true if the option is a Some value.

Examples

let x: Option<u32> = Some(2);
assert_eq!(x.is_some(), true);

let x: Option<u32> = None;
assert_eq!(x.is_some(), false);

pub fn is_none(&self) -> bool

Returns true if the option is a None value.

Examples

let x: Option<u32> = Some(2);
assert_eq!(x.is_none(), false);

let x: Option<u32> = None;
assert_eq!(x.is_none(), true);

pub fn as_ref(&self) -> Option<&T>

Converts from &Option<T> to Option<&T>.

Examples

Calculates the length of an Option<String> as an Option<usize> without moving the String. The map method takes the self argument by value, consuming the original, so this technique uses as_ref to first take an Option to a reference to the value inside the original.

let text: Option<String> = Some("Hello, world!".to_string());
// First, cast `Option<String>` to `Option<&String>` with `as_ref`,
// then consume *that* with `map`, leaving `text` on the stack.
let text_length: Option<usize> = text.as_ref().map(|s| s.len());
println!("still can print text: {text:?}");

pub fn as_pin_ref(self: Pin<&Option<T>>) -> Option<Pin<&T>>

Converts from Pin<&Option<T>> to Option<Pin<&T>>.

pub fn as_pin_mut(self: Pin<&mut Option<T>>) -> Option<Pin<&mut T>>

Converts from Pin<&mut Option<T>> to Option<Pin<&mut T>>.

pub fn as_slice(&self) -> &[T]

Returns a slice of the contained value, if any. If this is None, an empty slice is returned. This can be useful to have a single type of iterator over an Option or slice.

Note: Should you have an Option<&T> and wish to get a slice of T, you can unpack it via opt.map_or(&[], std::slice::from_ref).

Examples

assert_eq!(
    [Some(1234).as_slice(), None.as_slice()],
    [&[1234][..], &[][..]],
);

The inverse of this function is (discounting borrowing) [_]::first:

for i in [Some(1234_u16), None] {
    assert_eq!(i.as_ref(), i.as_slice().first());
}

pub fn as_deref(&self) -> Option<&<T as Deref>::Target>

where T: Deref,

Converts from Option<T> (or &Option<T>) to Option<&T::Target>.

Leaves the original Option in-place, creating a new one with a reference to the original one, additionally coercing the contents via Deref.

Examples

let x: Option<String> = Some("hey".to_owned());
assert_eq!(x.as_deref(), Some("hey"));

let x: Option<String> = None;
assert_eq!(x.as_deref(), None);

pub fn iter(&self) -> Iter<'_, T>

Returns an iterator over the possibly contained value.

Examples

let x = Some(4);
assert_eq!(x.iter().next(), Some(&4));

let x: Option<u32> = None;
assert_eq!(x.iter().next(), None);

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 From<Pair<'_>> for SrcRef

fn from(pair: Pair<'_>) -> 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

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

impl Deref for SrcRef

type Target = Option<Box<SrcRefInner>>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Eq for SrcRef