Struct oak_runtime::file_map_stream::Span

pub struct Span {
    pub lo: BytePos,
    pub hi: BytePos,
    pub expn_id: ExpnId,
}

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

expn_id: ExpnId

Information about where the macro came from, if this piece of code was created by a macro expansion.

Methods

impl Span

fn end_point(self) -> Span

Returns a new span representing just 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

Trait Implementations

impl Copy for Span

impl Ord for Span

fn cmp(&self, __arg_0: &Span) -> Ordering

This method returns an Ordering between self and other.

impl Decodable for Span

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

impl Eq for Span

impl Hash for Span

fn hash<__H>(&self, __arg_0: &mut __H) where __H: Hasher

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<(), Error>

Formats the value using the given formatter.

impl Encodable for Span

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

impl PartialOrd<Span> for Span

fn partial_cmp(&self, __arg_0: &Span) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, __arg_0: &Span) -> bool

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

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.

fn gt(&self, __arg_0: &Span) -> bool

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

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.

impl PartialEq<Span> for Span

fn eq(&self, __arg_0: &Span) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &Span) -> bool

This method tests for !=.