Struct Span

pub struct Span { /* private fields */ }

A region of source code.

Note that unlike proc_macro::Span, this struct contains a reference to the file containing it.

Implementations

impl Span

pub fn empty() -> Span

Create a new Span covering no tokens.

This span has a special ‘sentinel’ source file which is automatically overridden when joining with Span::across.

pub fn across(start: &Span, end: &Span) -> Span

Create a new Span from the start of start to the end of end.

Panics

This function will panic if start and end come from different source files and neither of them .

pub const fn is_empty(&self) -> bool

Returns true if self covers no tokens.

Trait Implementations

impl Clone for Span

fn clone(&self) -> Span

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Span

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

Formats the value using the given formatter.

impl<T: Token> From<&T> for Span

fn from(value: &T) -> Self

Converts to this type from the input type.

impl From<Span> for AngleBrackets

fn from(value: Span) -> Self

Converts to this type from the input type.

impl From<Span> for Braces

fn from(value: Span) -> Self

Converts to this type from the input type.

impl From<Span> for Brackets

fn from(value: Span) -> Self

Converts to this type from the input type.

impl From<Span> for DoubleQuotes

fn from(value: Span) -> Self

Converts to this type from the input type.

impl From<Span> for Parentheses

fn from(value: Span) -> Self

Converts to this type from the input type.

impl From<Span> for SingleQuotes

fn from(value: Span) -> Self

Converts to this type from the input type.

impl Hash for Span

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 Span

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

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

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

Available on crate feature ariadne only.

type SourceId = String

The identifier used to uniquely refer to a source. In most cases, this is the fully-qualified path of the file.

fn source(&self) -> &Self::SourceId

Get the identifier of the source that this span refers to.

fn start(&self) -> usize

Get the start offset of this span.

fn end(&self) -> usize

Get the (exclusive) end offset of this span.

fn len(&self) -> usize

Get the length of this span (difference between the start of the span and the end of the span).

fn contains(&self, offset: usize) -> bool

Determine whether the span contains the given offset.

impl Eq for Span

impl StructuralPartialEq for Span