Struct Span

#[repr(C)]
pub struct Span {
    pub lo: BytePos,
    pub hi: BytePos,
}

Spans represent a region of code, used for error reporting.

Positions in spans are absolute positions from the beginning of the source_map, 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 - 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 = hi - lo; there may be space in the BytePos range between files.

Fields

lo: BytePos

hi: BytePos

Implementations

impl Span

pub fn lo(self) -> BytePos

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

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

pub fn hi(self) -> BytePos

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

pub fn is_dummy(self) -> bool

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

pub fn is_pure(self) -> bool

pub fn is_placeholder(self) -> bool

pub fn is_dummy_ignoring_cmt(self) -> bool

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

pub fn shrink_to_lo(self) -> Span

Returns a new span representing an empty span at the beginning of this span

pub fn shrink_to_hi(self) -> Span

Returns a new span representing an empty span at the end of this span

pub fn substitute_dummy(self, other: Span) -> Span

Returns self if self is not the dummy span, and other otherwise.

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

Return true if self fully encloses other.

pub fn source_equal(self, other: Span) -> bool

Return true if the spans are equal with regards to the source text.

Use this instead of == when either span could be generated code, and you only care that they point to the same bytes of source text.

pub fn trim_start(self, other: Span) -> Option<Span>

Returns Some(span), where the start is trimmed by the end of other

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

Return a Span that would enclose both self and end.

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

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

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

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

pub fn from_inner_byte_pos(self, start: usize, end: usize) -> Span

pub fn dummy_with_cmt() -> Self

Dummy span, both position are extremely large numbers so they would be ignore by sourcemap, but can still have comments

Trait Implementations

impl Archive for Span

const COPY_OPTIMIZATION: CopyOptimization<Self> = _

An optimization flag that allows the bytes of this type to be copied directly to a writer instead of calling serialize.

type Archived = ArchivedSpan

The archived representation of this type.

type Resolver = SpanResolver

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.

fn resolve(&self, resolver: Self::Resolver, out: Place<Self::Archived>)

Creates the archived version of this value at the given position and writes it to the given output.

impl<__C: Fallible + ?Sized> CheckBytes<__C> for Span

where <__C as Fallible>::Error: Trace, BytePos: CheckBytes<__C>,

unsafe fn check_bytes( value: *const Self, context: &mut __C, ) -> Result<(), <__C as Fallible>::Error>

Checks whether the given pointer points to a valid value within the given context.

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<'de> Deserialize<'de> for Span

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<__D: Fallible + ?Sized> Deserialize<Span, __D> for Archived<Span>

fn deserialize( &self, deserializer: &mut __D, ) -> Result<Span, <__D as Fallible>::Error>

Deserializes using the given deserializer

impl EqIgnoreSpan for Span

fn eq_ignore_span(&self, _: &Self) -> bool

Always returns true

impl From<(BytePos, BytePos)> for Span

fn from(sp: (BytePos, BytePos)) -> Self

Converts to this type from the input type.

impl From<Span> for (BytePos, BytePos)

fn from(sp: Span) -> Self

Converts to this type from the input type.

impl From<Span> for MultiSpan

fn from(span: Span) -> MultiSpan

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<__S: Fallible + ?Sized> Serialize<__S> for Span

fn serialize( &self, serializer: &mut __S, ) -> Result<<Self as Archive>::Resolver, <__S as Fallible>::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.

impl Serialize for Span

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Spanned for Span

fn span(&self) -> Span

Get span of self.

fn span_lo(&self) -> BytePos

fn span_hi(&self) -> BytePos

impl Take for Span

fn dummy() -> Self

Create a dummy value of this type.

fn take(&mut self) -> Self

fn map_with_mut<F>(&mut self, op: F)

where F: FnOnce(Self) -> Self,

Mutate self using op, which accepts owned data.

impl TypeEq for Span

fn type_eq(&self, _: &Self) -> bool

Always returns true

impl Copy for Span

impl Eq for Span

impl StructuralPartialEq for Span