Struct Span

pub struct Span { /* private fields */ }

A source code location.

Essentially a lo..hi range into a SourceMap file’s source code.

Both lo and hi are offset by the file’s starting position.

Implementations

impl Span

pub const DUMMY: Self = _

A dummy span.

pub fn new(lo: BytePos, hi: BytePos) -> Self

Creates a new span from two byte positions.

pub fn lo(self) -> BytePos

Returns the span’s start position.

pub fn with_lo(self, lo: BytePos) -> Self

Creates a new span with the same hi position as this span and the given lo position.

pub fn hi(self) -> BytePos

Returns the span’s end position.

pub fn with_hi(self, hi: BytePos) -> Self

Creates a new span with the same lo position as this span and the given hi position.

pub fn shrink_to_lo(self) -> Self

Creates a new span representing an empty span at the beginning of this span.

pub fn shrink_to_hi(self) -> Self

Creates a new span representing an empty span at the end of this span.

pub fn is_dummy(self) -> bool

Returns true if this is a dummy span.

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

Returns true if self fully encloses other.

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

Returns true if self touches other.

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

Returns true if self and other are equal.

pub fn split_at(self, pos: u32) -> (Self, Self)

Splits a span into two composite spans around a certain position.

pub fn to(self, end: Self) -> Self

Returns a Span that would enclose both self and end.

Note that this can also be used to extend the span “backwards”: start.to(end) and end.to(start) return the same Span.

    ____             ___
    self lorem ipsum end
    ^^^^^^^^^^^^^^^^^^^^

pub fn between(self, end: Self) -> Self

Returns a Span between the end of self to the beginning of end.

    ____             ___
    self lorem ipsum end
        ^^^^^^^^^^^^^

pub fn until(self, end: Self) -> Self

Returns a Span from the beginning of self until the beginning of end.

    ____             ___
    self lorem ipsum end
    ^^^^^^^^^^^^^^^^^

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() -> Self

Returns the “default value” for a type.

impl Default for Span

fn default() -> Self

Returns the “default value” for a type.

impl From<Span> for MultiSpan

fn from(span: 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 Copy for Span

impl Eq for Span

impl StructuralPartialEq for Span