[][src]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[src]

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

pub fn data(self) -> SpanData[src]

impl Span[src]

pub fn lo(self) -> BytePos[src]

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

pub fn hi(self) -> BytePos[src]

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

pub fn ctxt(self) -> SyntaxContext[src]

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

pub fn is_dummy(self) -> bool[src]

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

pub fn shrink_to_lo(self) -> Span[src]

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

pub fn shrink_to_hi(self) -> Span[src]

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

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

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

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

Return true if self fully encloses other.

pub fn overlaps(self, other: Span) -> bool[src]

Return true if self touches other.

pub fn source_equal(&self, other: &Span) -> bool[src]

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>[src]

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

pub fn source_callsite(self) -> Span[src]

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>[src]

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

pub fn edition(self) -> Edition[src]

Edition of the crate from which this span came.

pub fn rust_2015(&self) -> bool[src]

pub fn rust_2018(&self) -> bool[src]

pub fn source_callee(self) -> Option<ExpnInfo>[src]

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[src]

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[src]

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

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

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

pub fn allows_unsafe(&self) -> bool[src]

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>[src]

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

Return a Span that would enclose both self and end.

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

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

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

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[src]

pub fn apply_mark(self, mark: Mark) -> Span[src]

pub fn remove_mark(&mut self) -> Mark[src]

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

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

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

pub fn modern(self) -> Span[src]

pub fn modern_and_legacy(self) -> Span[src]

Trait Implementations

impl Eq for Span[src]

impl Clone for Span[src]

fn clone_from(&mut self, source: &Self)
1.0.0
[src]

Performs copy-assignment from source. Read more

impl !Send for Span[src]

impl Copy for Span[src]

impl PartialOrd<Span> for Span[src]

#[must_use]
fn lt(&self, other: &Rhs) -> bool
1.0.0
[src]

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

#[must_use]
fn le(&self, other: &Rhs) -> bool
1.0.0
[src]

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

#[must_use]
fn gt(&self, other: &Rhs) -> bool
1.0.0
[src]

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

#[must_use]
fn ge(&self, other: &Rhs) -> bool
1.0.0
[src]

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

impl PartialEq<Span> for Span[src]

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0
[src]

This method tests for !=.

impl !Sync for Span[src]

impl Default for Span[src]

impl Ord for Span[src]

fn max(self, other: Self) -> Self
1.21.0
[src]

Compares and returns the maximum of two values. Read more

fn min(self, other: Self) -> Self
1.21.0
[src]

Compares and returns the minimum of two values. Read more

impl From<Span> for MultiSpan[src]

impl Hash for Span[src]

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher
1.3.0
[src]

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

impl Debug for Span[src]

impl UseSpecializedEncodable for Span[src]

impl UseSpecializedDecodable for Span[src]

Blanket Implementations

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

impl<T> From for T[src]

impl<T, U> TryFrom for T where
    U: Into<T>, 
[src]

type Error = !

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T> Encodable for T where
    T: UseSpecializedEncodable + ?Sized
[src]

impl<T> Decodable for T where
    T: UseSpecializedDecodable
[src]

impl<E> SpecializationError for E[src]

impl<T> Erased for T[src]

impl<T> Send for T where
    T: ?Sized
[src]

impl<T> Sync for T where
    T: ?Sized
[src]