Struct Span 

pub struct Span {
    pub file_id: FileId,
    pub start: Position,
    pub end: Position,
}

Represents a contiguous range of source code within a single file.

A Span is defined by a start and end Position, marking the beginning (inclusive) and end (exclusive) of a source code segment.

Fields

file_id: FileId

The unique identifier of the file this span belongs to.

start: Position

The start position is inclusive, meaning it includes the byte at this position.

end: Position

The end position is exclusive, meaning it does not include the byte at this position.

Implementations

impl Span

pub const fn new(file_id: FileId, start: Position, end: Position) -> Self

Creates a new Span from a start and end position.

Panics

In debug builds, this will panic if the start and end positions are not from the same file (unless one is a dummy position).

pub const fn zero() -> Self

Creates a new Span with a zero-length, starting and ending at the same position.

pub fn dummy(start_offset: u32, end_offset: u32) -> Self

Creates a “dummy” span with a null file ID.

pub fn between(start: Span, end: Span) -> Self

Creates a new span that starts at the beginning of the first span and ends at the conclusion of the second span.

pub const fn is_zero(&self) -> bool

Checks if this span is a zero-length span, meaning it starts and ends at the same position.

pub fn join(self, other: Span) -> Span

Creates a new span that encompasses both self and other. The new span starts at self.start and ends at other.end.

pub fn to_end(&self, end: Position) -> Span

Creates a new span that starts at the beginning of this span and ends at the specified position.

pub fn from_start(&self, start: Position) -> Span

Creates a new span that starts at the specified position and ends at the end of this span.

pub fn subspan(&self, start: u32, end: u32) -> Span

Creates a new span that is a subspan of this span, defined by the given byte offsets. The start and end parameters are relative to the start of this span.

pub fn contains(&self, position: &impl HasPosition) -> bool

Checks if a position is contained within this span’s byte offsets.

pub fn has_offset(&self, offset: u32) -> bool

Checks if a raw byte offset is contained within this span.

pub fn to_range(&self) -> Range<u32>

Converts the span to a Range<u32> of its byte offsets.

pub fn to_range_usize(&self) -> Range<usize>

Converts the span to a Range<usize> of its byte offsets.

pub fn to_offset_tuple(&self) -> (u32, u32)

Converts the span to a tuple of byte offsets.

pub fn length(&self) -> u32

Returns the length of the span in bytes.

pub fn is_before(&self, other: &impl HasPosition) -> bool

pub fn is_after(&self, other: &impl HasPosition) -> bool

Trait Implementations

impl Clone for Span

fn clone(&self) -> Span

Returns a duplicate 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 Display for Span

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

Formats the value using the given formatter.

impl From<&Span> for Range<u32>

fn from(span: &Span) -> Range<u32>

Converts to this type from the input type.

impl From<&Span> for Range<usize>

fn from(span: &Span) -> Range<usize>

Converts to this type from the input type.

impl From<Span> for Range<u32>

fn from(span: Span) -> Range<u32>

Converts to this type from the input type.

impl From<Span> for Range<usize>

fn from(span: Span) -> Range<usize>

Converts to this type from the input type.

impl HasFileId for Span

fn file_id(&self) -> FileId

Returns the unique identifier of the file.

impl HasSpan for Span

fn span(&self) -> Span

Returns the source span.

fn start_position(&self) -> Position

A convenience method to get the starting position of the span.

fn start_offset(&self) -> u32

A convenience method to get the starting byte offset of the span.

fn end_position(&self) -> Position

A convenience method to get the ending position of the span.

fn end_offset(&self) -> u32

A convenience method to get the ending byte offset of the span.

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: &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 RangeBounds<u32> for Span

fn start_bound(&self) -> Bound<&u32>

Start index bound.

fn end_bound(&self) -> Bound<&u32>

End index bound.

fn contains<U>(&self, item: &U) -> bool

where T: PartialOrd<U>, U: PartialOrd<T> + ?Sized,

Returns true if item is contained in the range.

fn is_empty(&self) -> bool

where T: PartialOrd,

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

Returns true if the range contains no items. One-sided ranges (RangeFrom, etc) always return false.

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