Struct Span

pub struct Span { /* private fields */ }

Represents a range of text within a document, as a Start and End offset.

Effectively two SourceOffsets in one struct.

Implementations

impl Span

pub const DUMMY: Span

Represents a fake Span with SourceOffset::DUMMY as the start/end offsets.

pub const ZERO: Span

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

Creates a new Span given a starting SourceOffset and an ending SourceOffset.

Asserts: start <= end

pub const fn start(&self) -> SourceOffset

Gets the starting SourceOffset.

pub const fn end(&self) -> SourceOffset

Gets the ending SourceOffset.

pub fn with_end(self, end: SourceOffset) -> Self

Extends this Span into a new one with the end altered to be SourceOffset.

Asserts: start <= end

pub fn contains(&self, span: Span) -> bool

Checks if the given Span would fit entirely within this Span.

pub const fn is_empty(&self) -> bool

Checks if the Span has no length.

pub fn len(&self) -> u32

Returns the length of the Span.

pub fn line_and_column(self, source: &str) -> (u32, u32)

Given a string source, establish the line number and column number that this span would reside in.

Trait Implementations

impl Add for Span

Extends this Span, ensuring that the resulting new Span is broader than both this and the given Span. In other words the resulting span will always Span::contains() both Spans.

type Output = Span

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

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

fn default() -> Span

Returns the “default value” for a type.

impl Display for Span

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

Formats the value using the given formatter.

impl From<Cursor> for Span

fn from(cursor: Cursor) -> Self

Converts to this type from the input type.

impl From<Span> for SourceSpan

fn from(val: 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<Span> for Cursor

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

fn to_span(&self) -> Span

impl Copy for Span

impl Eq for Span

impl StructuralPartialEq for Span