Struct swc_common::Span

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 source_map, not positions relative to SourceFiles. Methods on the SourceMap 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 source_map 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.

Implementations

impl Span

pub fn lo(self) -> BytePos

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

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 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>>

Trait Implementations

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

impl Debug for Span

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

Formats the value using the given formatter.

impl Default for Span

fn default() -> Self

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Span

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for Span

impl From<Span> for MultiSpan

fn from(span: Span) -> MultiSpan

Performs the conversion.

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

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<Span> 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: &Span) -> bool

This method tests for !=.

impl PartialOrd<Span> for Span

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

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

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

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

fn le(&self, other: &Span) -> bool

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

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

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

fn ge(&self, other: &Span) -> bool

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

impl Serialize for Span

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Spanned for Span

fn span(&self) -> Span

Get span of self.

impl StructuralEq for Span

impl StructuralPartialEq for Span