Struct syntax_pos::SpanData

pub struct SpanData {
    pub lo: BytePos,
    pub hi: BytePos,
    pub ctxt: SyntaxContext,
}

Spans represent a region of code, used for error reporting. Positions in spans are absolute positions from the beginning of the codemap, not positions relative to FileMaps. Methods on the CodeMap can be used to relate spans back to the original source. You must be careful if the span crosses more than one file - you will not be able to use many of the functions on spans in codemap and you cannot assume that the length of the span = hi - lo; there may be space in the BytePos range between files.

SpanData is public because Span uses a thread-local interner and can't be sent to other threads, but some pieces of performance infra run in a separate thread. Using Span is generally preferred.

Fields

lo: BytePos

hi: BytePos

ctxt: SyntaxContext

Information about where the macro came from, if this piece of code was created by a macro expansion.

Methods

impl SpanData

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

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

pub fn with_ctxt(&self, ctxt: SyntaxContext) -> Span

Trait Implementations

impl Clone for SpanData

fn clone(&self) -> SpanData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for SpanData

impl Hash for SpanData

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,

Feeds a slice of this type into the given [Hasher].

impl PartialEq for SpanData

fn eq(&self, other: &SpanData) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SpanData) -> bool

This method tests for !=.

impl Eq for SpanData

impl Ord for SpanData

fn cmp(&self, other: &SpanData) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl PartialOrd for SpanData

fn partial_cmp(&self, other: &SpanData) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &SpanData) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &SpanData) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &SpanData) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &SpanData) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Debug for SpanData

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

Formats the value using the given formatter.