[−][src]Struct syntax::source_map::Span
A compressed span.
SpanData
is 12 bytes, which is a bit too big to stick everywhere. Span
is a form that only takes up 8 bytes, with less space for the length and
context. The vast majority (99.9%+) of SpanData
instances will fit within
those 8 bytes; any SpanData
whose fields don't fit into a Span
are
stored in a separate interner table, and the Span
will index into that
table. Interning is rare enough that the cost is low, but common enough
that the code is exercised regularly.
An earlier version of this code used only 4 bytes for Span
, but that was
slower because only 80--90% of spans could be stored inline (even less in
very large crates) and so the interner was used a lot more.
Inline (compressed) format:
span.base_or_index == span_data.lo
span.len_or_tag == len == span_data.hi - span_data.lo
(must be<= MAX_LEN
)span.ctxt == span_data.ctxt
(must be<= MAX_CTXT
)
Interned format:
span.base_or_index == index
(indexes into the interner table)span.len_or_tag == LEN_TAG
(high bit set, all other bits are zero)span.ctxt == 0
The inline form uses 0 for the tag value (rather than 1) so that we don't need to mask out the tag bit when getting the length, and so that the dummy span can be all zeroes.
Notes about the choice of field sizes:
base
is 32 bits in bothSpan
andSpanData
, which means thatbase
values never cause interning. The number of bits needed forbase
depends on the crate size. 32 bits allows up to 4 GiB of code in a crate.script-servo
is the largest crate inrustc-perf
, requiring 26 bits for some spans.len
is 15 bits inSpan
(a u16, minus 1 bit for the tag) and 32 bits inSpanData
, which means that largelen
values will cause interning. The number of bits needed forlen
does not depend on the crate size. The most common number of bits forlen
are 0--7, with a peak usually at 3 or 4, and then it drops off quickly from 8 onwards. 15 bits is enough for 99.99%+ of cases, but larger values (sometimes 20+ bits) might occur dozens of times in a typical crate.ctxt
is 16 bits inSpan
and 32 bits inSpanData
, which means that largectxt
values will cause interning. The number of bits needed forctxt
values depend partly on the crate size and partly on the form of the code. No crates inrustc-perf
need more than 15 bits forctxt
, but larger crates might need more than 16 bits.
Methods
impl Span
[src]
pub fn new(lo: BytePos, hi: BytePos, ctxt: SyntaxContext) -> Span
[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]
Returns true
if self
fully encloses other
.
pub fn overlaps(self, other: Span) -> bool
[src]
Returns true
if self
touches other
.
pub fn source_equal(&self, other: &Span) -> bool
[src]
Returns 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]
Returns 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]
Returns 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, feature: &str) -> bool
[src]
Checks 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]
Checks if this span arises from a compiler desugaring of kind kind
.
pub fn compiler_desugaring_kind(&self) -> Option<CompilerDesugaringKind>
[src]
Returns the compiler desugaring that created this span, or None
if this span is not from a desugaring.
pub fn allows_unsafe(&self) -> bool
[src]
Checks 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]
Returns a Span
that would enclose both self
and end
.
pub fn between(self, end: Span) -> Span
[src]
Returns a Span
between the end of self
to the beginning of end
.
pub fn until(self, end: Span) -> Span
[src]
Returns 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]
&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>>
[src]
&mut self,
expansion: Mark,
glob_ctxt: SyntaxContext
) -> Option<Option<Mark>>
pub fn modern(self) -> Span
[src]
pub fn modern_and_legacy(self) -> Span
[src]
Trait Implementations
impl Copy for Span
[src]
impl Ord for Span
[src]
fn cmp(&self, rhs: &Span) -> Ordering
[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
fn clamp(self, min: Self, max: Self) -> Self
[src]
clamp
)Restrict a value to a certain interval. Read more
impl Clone for Span
[src]
fn clone(&self) -> Span
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl !Sync for Span
[src]
impl From<Span> for MultiSpan
[src]
impl PartialOrd<Span> for Span
[src]
fn partial_cmp(&self, rhs: &Span) -> Option<Ordering>
[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 Hash for Span
[src]
fn hash<__H>(&self, state: &mut __H) where
__H: Hasher,
[src]
__H: Hasher,
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
Feeds a slice of this type into the given [Hasher
]. Read more
impl Debug for Span
[src]
impl Eq for Span
[src]
impl Default for Span
[src]
impl UseSpecializedDecodable for Span
[src]
impl PartialEq<Span> for Span
[src]
impl !Send for Span
[src]
impl UseSpecializedEncodable for Span
[src]
Blanket Implementations
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Encodable for T where
T: UseSpecializedEncodable + ?Sized,
[src]
T: UseSpecializedEncodable + ?Sized,
impl<T> Decodable for T where
T: UseSpecializedDecodable,
[src]
T: UseSpecializedDecodable,
impl<E> SpecializationError for E
[src]
default fn not_found<S, T>(
trait_name: &'static str,
method_name: &'static str
) -> E where
T: ?Sized,
[src]
trait_name: &'static str,
method_name: &'static str
) -> E where
T: ?Sized,
impl<T> Send for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Sync for T where
T: ?Sized,
[src]
T: ?Sized,