Struct Loc

pub struct Loc {
    pub span: SourceSpan,
    pub src: Arc<str>,
}

Represents a source location: index/range, and a reference to the source code which that index/range indexes into

Fields

span: SourceSpan

SourceSpan indicating a specific source code location or range

src: Arc<str>

Original source code (which the above source span indexes into)

Implementations

impl Loc

pub fn new(span: impl Into<SourceSpan>, src: Arc<str>) -> Self

Create a new Loc

pub fn span(&self, span: impl Into<SourceSpan>) -> Self

Create a new Loc with the same source code but a different span

pub fn start(&self) -> usize

Get the index representing the start of the source span

pub fn end(&self) -> usize

Get the index representing the end of the source span

pub fn snippet(&self) -> Option<&str>

Get the actual source snippet indicated, or None if the Loc isn’t internally consistent (its SourceSpan isn’t a valid index into its src)

Trait Implementations

impl Clone for Loc

fn clone(&self) -> Loc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Loc

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Loc

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Loc> for SourceSpan

fn from(loc: &Loc) -> Self

Converts to this type from the input type.

impl From<Loc> for SourceSpan

fn from(loc: Loc) -> Self

Converts to this type from the input type.

impl Hash for Loc

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 Loc

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

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

fn partial_cmp(&self, other: &Loc) -> 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 Serialize for Loc

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SourceCode for &Loc

fn read_span<'a>( &'a self, span: &SourceSpan, context_lines_before: usize, context_lines_after: usize, ) -> Result<Box<dyn SpanContents<'a> + 'a>, MietteError>

Read the bytes for a specific span from this SourceCode, keeping a certain number of lines before and after the span as context.

impl SourceCode for Loc

fn read_span<'a>( &'a self, span: &SourceSpan, context_lines_before: usize, context_lines_after: usize, ) -> Result<Box<dyn SpanContents<'a> + 'a>, MietteError>

Read the bytes for a specific span from this SourceCode, keeping a certain number of lines before and after the span as context.

impl Eq for Loc

impl StructuralPartialEq for Loc