Struct syntax_pos::Span

#[repr(packed)]
pub struct Span(_);

A compressed span. Contains either fields of SpanData inline if they are small, or index into span interner. The primary goal of Span is to be as small as possible and fit into other structures (that's why it uses packed as well). Decoding speed is the second priority. See SpanData for the info on span fields in decoded representation.

Methods

impl Span

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

pub fn data(self) -> SpanData

impl Span

pub fn lo(self) -> BytePos

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

pub fn hi(self) -> BytePos

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

pub fn ctxt(self) -> SyntaxContext

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

pub fn is_dummy(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 source_callsite(self) -> Span

Return the source span - this is either the supplied span, or the span for the macro callsite that expanded to it.

pub fn parent(self) -> Option<Span>

The Span for the tokens in the previous macro expansion from which self was generated, if any

pub fn edition(self) -> Edition

Edition of the crate from which this span came.

pub fn source_callee(self) -> Option<ExpnInfo>

Return the source callee.

Returns None if the supplied span has no expansion trace, else returns the ExpnInfo for the macro definition corresponding to the source callsite.

pub fn allows_unstable(&self) -> bool

Check if a span is "internal" to a macro in which #[unstable] items can be used (that is, a macro marked with #[allow_internal_unstable]).

pub fn is_compiler_desugaring(&self, kind: CompilerDesugaringKind) -> bool

Check if this span arises from a compiler desugaring of kind kind.

pub fn compiler_desugaring_kind(&self) -> Option<CompilerDesugaringKind>

Return the compiler desugaring that created this span, or None if this span is not from a desugaring.

pub fn allows_unsafe(&self) -> bool

Check if a span is "internal" to a macro in which unsafe can be used without triggering the unsafe_code lint

pub fn macro_backtrace(self) -> Vec<MacroBacktrace>

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 apply_mark(self, mark: Mark) -> Span

pub fn remove_mark(&mut self) -> Mark

pub fn adjust(&mut self, expansion: Mark) -> Option<Mark>

pub fn glob_adjust(     &mut self,     expansion: Mark,     glob_ctxt: SyntaxContext ) -> Option<Option<Mark>>

pub fn reverse_glob_adjust(     &mut self,     expansion: Mark,     glob_ctxt: SyntaxContext ) -> Option<Option<Mark>>

pub fn modern(self) -> Span

pub fn modern_and_legacy(self) -> Span

Trait Implementations

impl Copy for Span

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

fn eq(&self, other: &Span) -> 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 !=.

impl Eq for Span

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,

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

impl !Send for Span

impl !Sync for Span

impl PartialOrd for Span

fn partial_cmp(&self, rhs: &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 Ord for Span

fn cmp(&self, rhs: &Self) -> 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 Default for Span

fn default() -> Self

Returns the "default value" for a type.

impl UseSpecializedEncodable for Span

fn default_encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

Defaults to returning an error (see SpecializationError).

impl UseSpecializedDecodable for Span

fn default_decode<D: Decoder>(d: &mut D) -> Result<Span, D::Error>

Defaults to returning an error (see SpecializationError).

impl Debug for Span

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

Formats the value using the given formatter.

impl From<Span> for MultiSpan

fn from(span: Span) -> MultiSpan

Performs the conversion.