Struct Span

pub struct Span {
    pub start: usize,
    pub end: usize,
}

Spans are a global offset across all seen files, which are cached in the engine’s state. The start and end offset together make the inclusive start/exclusive end pair for where to underline to highlight a given point of interest.

Fields

start: usize

end: usize

Implementations

impl Span

pub fn new(start: usize, end: usize) -> Self

pub const fn unknown() -> Self

pub const fn test_data() -> Self

Span for testing purposes.

The provided span does not point into any known source but is unequal to Span::unknown().

Note: Only use this for test data, not live data, as it will point into unknown source when used in errors

pub fn offset(&self, offset: usize) -> Self

pub fn contains(&self, pos: usize) -> bool

pub fn contains_span(&self, span: Self) -> bool

pub fn past(&self) -> Self

Point to the space just past this span, useful for missing values

pub fn from_row_column(row: usize, col: usize, contents: &str) -> Span

Converts row and column in a String to a Span, assuming bytes (1-based rows)

pub fn append(self, after: Self) -> Self

Returns the minimal Span that encompasses both of the given spans.

The two Spans can overlap in the middle, but must otherwise be in order by satisfying:

• self.start <= after.start
• self.end <= after.end

If this is not guaranteed to be the case, use Span::merge instead.

pub fn merge(self, other: Self) -> Self

Returns the minimal Span that encompasses both of the given spans.

The spans need not be in order or have any relationship.

Span::append is slightly more efficient if the spans are known to be in order.

pub fn concat(spans: &[Self]) -> Self

Returns the minimal Span that encompasses all of the spans in the given slice.

The spans are assumed to be in order, that is, all consecutive spans must satisfy:

• spans[i].start <= spans[i + 1].start
• spans[i].end <= spans[i + 1].end

(Two consecutive spans can overlap as long as the above is true.)

Use Span::merge_many if the spans are not known to be in order.

pub fn merge_many(spans: impl IntoIterator<Item = Self>) -> Self

Returns the minimal Span that encompasses all of the spans in the given iterator.

The spans need not be in order or have any relationship.

Span::concat is more efficient if the spans are known to be in order.

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, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

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 From<Span> for SourceSpan

fn from(s: Span) -> Self

Converts to this type from the input type.

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: &Span) -> 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>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Span

impl Eq for Span

impl StructuralPartialEq for Span