Struct Span 

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

Span type that tracks a byte range.

Example

use sipha_core::span::Span;

let span = Span::new(10, 20);
assert_eq!(span.start(), 10);
assert_eq!(span.end(), 20);

Fields

start: usize

Start byte offset (inclusive).

end: usize

End byte offset (exclusive).

Implementations

impl Span

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

Create a new span with start/end positions.

Panics

Panics if end < start in debug mode.

pub fn from_range(range: Range<usize>) -> Self

Create a span from a range.

pub fn empty(pos: usize) -> Self

Create an empty span at the given position.

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

Get the range of this span.

pub fn start(&self) -> usize

Get the start byte offset.

pub fn end(&self) -> usize

Get the end byte offset.

pub fn len(&self) -> usize

Get the length of the span in bytes.

pub fn is_empty(&self) -> bool

Check if the span is empty (start == end).

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

Check if this span contains the given position.

A position is contained if it’s >= start and < end.

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

Check if this span contains another span entirely.

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

Check if this span overlaps with another span.

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

Check if this span is adjacent to another span (touching but not overlapping).

pub fn join(self, other: Self) -> Option<Self>

Join two adjacent or overlapping spans into one.

Returns None if the spans are not adjacent/overlapping.

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

Merge two spans into one, creating the smallest span that contains both.

pub fn intersection(self, other: Self) -> Option<Self>

Get the intersection of two spans, if they overlap.

Returns None if the spans don’t overlap.

pub fn before(&self, start_pos: usize) -> Option<Self>

Get the span that comes before this span, from start_pos to this span’s start.

Returns None if start_pos >= self.start().

Example

use sipha_core::span::Span;

let span = Span::new(10, 20);
let before = span.before(5);
assert_eq!(before, Some(Span::new(5, 10)));

pub fn after(&self, end_pos: usize) -> Option<Self>

Get the span that comes after this span, from this span’s end to end_pos.

Returns None if end_pos <= self.end().

Example

use sipha_core::span::Span;

let span = Span::new(10, 20);
let after = span.after(25);
assert_eq!(after, Some(Span::new(20, 25)));

pub fn expand_to_include(&mut self, other: &Self)

Expand this span to include another span.

This is equivalent to self.merge(other) but modifies self in place.

Example

use sipha_core::span::Span;

let mut span = Span::new(10, 20);
span.expand_to_include(&Span::new(25, 30));
assert_eq!(span, Span::new(10, 30));

pub fn split_at(&self, pos: usize) -> Option<(Self, Self)>

Split this span at the given position, returning two spans.

Returns (before, after) where:

• before is the span from self.start() to pos (exclusive)
• after is the span from pos to self.end()

Returns None if pos is not within this span.

Example

use sipha_core::span::Span;

let span = Span::new(10, 20);
let (before, after) = span.split_at(15).unwrap();
assert_eq!(before, Span::new(10, 15));
assert_eq!(after, Span::new(15, 20));

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

fn default() -> Self

Returns the “default value” for a type.

impl From<Range<usize>> for Span

fn from(range: Range<usize>) -> Self

Converts to this type from the input type.

impl From<Span> for Range<usize>

fn from(span: 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 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 Copy for Span

impl Eq for Span

impl StructuralPartialEq for Span