Struct rustc_span::SpanData

pub struct SpanData {
    pub lo: BytePos,
    pub hi: BytePos,
    pub ctxt: SyntaxContext,
    pub parent: Option<LocalDefId>,
}

Represents a span.

Spans represent a region of code, used for error reporting. Positions in spans are absolute positions from the beginning of the SourceMap, not positions relative to SourceFiles. Methods on the SourceMap can be used to relate spans back to the original source.

You must be careful if the span crosses more than one file, since you will not be able to use many of the functions on spans in source_map and you cannot assume that the length of the span is equal to span.hi - span.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.

parent: Option<LocalDefId>

Implementations

impl SpanData

pub fn span(&self) -> Span

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

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

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

Avoid if possible, Span::map_ctxt should be preferred.

pub(crate) fn with_parent(&self, parent: Option<LocalDefId>) -> Span

Avoid if possible, Span::with_parent should be preferred.

pub fn is_dummy(self) -> bool

Returns true if this is a dummy span with any hygienic context.

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

Returns true if self fully encloses other.

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 Debug for SpanData

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

Formats the value using the given formatter.

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SpanData

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

Restrict a value to a certain interval.

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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for SpanData

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

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

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

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

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

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

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

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

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

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

impl Copy for SpanData

impl Eq for SpanData

impl StructuralPartialEq for SpanData

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 16 bytes