Struct Span

pub struct Span { /* private fields */ }

A source code span, used for error reporting.

Implementations

impl Span

pub const UNDEFINED: Self = _

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

Creates a new Span from a range of byte indices

Note: end is exclusive, it doesn’t belong to the Span

pub const fn until(&self, other: &Self) -> Self

Returns a new Span starting at self and ending at other

pub fn subsume(&mut self, other: Self)

Modifies self to contain the smallest Span possible that contains both self and other

pub fn total_span<T: Iterator<Item = Self>>(from: T) -> Self

Returns the smallest Span possible that contains all the Spans defined in the from iterator

pub fn to_range(self) -> Option<Range<usize>>

Converts self to a range if the span is not unknown

pub fn is_defined(&self) -> bool

Check whether self was defined or is a default/unknown span

pub fn location(&self, source: &str) -> SourceLocation

Return a SourceLocation for this span in the provided source.

Trait Implementations

impl Clone for Span

fn clone(&self) -> Span

Returns a copy 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 Default for Span

fn default() -> Span

Returns the “default value” for a type.

impl From<Range<usize>> for Span

fn from(range: Range<usize>) -> Self

Converts to this type from the input type.

impl Index<Span> for str

type Output = str

The returned type after indexing.

fn index(&self, span: Span) -> &str

Performs the indexing (container[index]) operation.

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 Copy for Span

impl StructuralPartialEq for Span