Struct syntex_pos::Span
[−]
[src]
pub struct Span { pub lo: BytePos, pub hi: BytePos, pub ctxt: SyntaxContext, }
Spans represent a region of code, used for error reporting. Positions in spans are absolute positions from the beginning of the codemap, not positions relative to FileMaps. Methods on the CodeMap 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 codemap 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
ctxt: SyntaxContext
Information about where the macro came from, if this piece of code was created by a macro expansion.
Methods
impl Span
[src]
fn end_point(self) -> Span
Returns a new span representing just the end-point of this span
fn next_point(self) -> Span
Returns a new span representing the next character after the end-point of this span
fn substitute_dummy(self, other: Span) -> Span
Returns self
if self
is not the dummy span, and other
otherwise.
fn contains(self, other: Span) -> bool
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.
fn trim_start(self, other: Span) -> Option<Span>
Returns Some(span)
, where the start is trimmed by the end of other
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.
fn source_callee(self) -> Option<NameAndSpan>
Return the source callee.
Returns None if the supplied span has no expansion trace, else returns the NameAndSpan for the macro definition corresponding to the source callsite.
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]
).
fn macro_backtrace(self) -> Vec<MacroBacktrace>
fn to(self, end: Span) -> Span
fn between(self, end: Span) -> Span
fn until(self, end: Span) -> Span
Trait Implementations
impl Clone for Span
[src]
fn clone(&self) -> Span
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0
Performs copy-assignment from source
. Read more
impl Copy for Span
[src]
impl Hash for Span
[src]
fn hash<__H: Hasher>(&self, __arg_0: &mut __H)
Feeds this value into the given [Hasher
]. Read more
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0
H: Hasher,
Feeds a slice of this type into the given [Hasher
]. Read more
impl PartialEq for Span
[src]
fn eq(&self, __arg_0: &Span) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &Span) -> bool
This method tests for !=
.
impl Eq for Span
[src]
impl Ord for Span
[src]
fn cmp(&self, __arg_0: &Span) -> Ordering
This method returns an Ordering
between self
and other
. Read more
impl PartialOrd for Span
[src]
fn partial_cmp(&self, __arg_0: &Span) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, __arg_0: &Span) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, __arg_0: &Span) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, __arg_0: &Span) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, __arg_0: &Span) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more