Struct Span 

pub struct Span(pub Range<u32>);

Starting and ending positions of some token inside the source code.

Tuple Fields

0: Range<u32>

Implementations

impl Span

pub fn start(&self) -> usize

Offset within the source code (in bytes) were the span starts.

pub fn end(&self) -> usize

Offset within the source code (in bytes) where the span ends.

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

Returns the span as a range of byte offsets.

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

Returns a new Span that combines this span with other.

The resulting span goes from self.start() to other.end().

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

Returns true if this span completely contains other.

Both the start and end of the other span must be within the limits of this span.

assert!(Span(0..3).contains(&Span(0..2)));
assert!(Span(0..3).contains(&Span(1..3)));
assert!(Span(0..3).contains(&Span(0..3)));
assert!(!Span(0..3).contains(&Span(0..4)));
assert!(!Span(0..3).contains(&Span(3..4)));

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

Returns a new Span that is a subspan of the original one.

start and end are the starting and ending offset of the subspan, relative to the start of the original span.

pub fn offset(self, offset: isize) -> Self

Displace the span by adding offset to both the starting and ending positions.

assert_eq!(Span(0..1).offset(1), Span(1..2));
assert_eq!(Span(1..2).offset(-1), Span(0..1));

Panics

Panics if the new span has a start or end positions that are negative or larger than Span::MAX.

Span(0..1).offset(-1);

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() -> 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<Range<usize>> for Span

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

impl StructuralPartialEq for Span