Struct Span

pub struct Span { /* private fields */ }

Represents a span of the source code in a specific file.

Implementations

impl Span

pub fn dummy() -> Span

pub fn new( src: Arc<str>, start: usize, end: usize, source: Option<SourceId>, ) -> Option<Span>

pub fn from_string(source: String) -> Span

pub fn src(&self) -> &Arc<str>

pub fn start(&self) -> usize

pub fn end(&self) -> usize

pub fn source_id(&self) -> Option<&SourceId>

pub fn start_pos(&self) -> Position<'_>

pub fn end_pos(&self) -> Position<'_>

pub fn split(&self) -> (Position<'_>, Position<'_>)

pub fn str(self) -> String

pub fn as_str(&self) -> &str

pub fn input(&self) -> &str

pub fn trim(self) -> Span

pub fn next_char_utf8(&self) -> Option<Span>

Creates a new span that points to very next char of the current span.

let
   ^ <- span returned
^^^  <- original span

pub fn join(s1: Span, s2: &Span) -> Span

This panics if the spans are not from the same file. This should only be used on spans that are actually next to each other.

pub fn join_all(spans: impl IntoIterator<Item = Span>) -> Span

pub fn line_col(&self) -> LineColRange

Returns the line and column start and end.

pub fn is_dummy(&self) -> bool

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

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Span> for Range<usize>

fn from(value: Span) -> Self

Converts to this type from the input type.

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, Self: Sized,

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.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Span

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd 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: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Span

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Eq for Span