Struct Span 

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

A half-open byte range [start, end) into a source text, tagged with the revision of that text it refers to.

Spans are the currency of this crate: every node in a ParseTree covers a span of the source, and passes consume a span and produce child spans.

Examples

use increparse::Span;

let outer = Span::new(0, 10, 0);
let inner = Span::new(2, 5, 0);

assert_eq!(outer.len(), 10);
assert!(outer.contains(&inner));
assert!(outer.overlaps(&inner));
assert!(!inner.contains(&outer));

Fields

start: usize

Byte offset of the first byte covered by the span.

end: usize

Byte offset one past the last byte covered by the span.

rev: u64

Revision of the source text this span indexes into.

Implementations

impl Span

pub fn new(start: usize, end: usize, rev: u64) -> Span

Creates a span over [start, end) of source revision rev.

Panics

Panics in debug builds if start > end.

pub fn len(&self) -> usize

Length of the span in bytes.

pub fn is_empty(&self) -> bool

Returns true if the span covers zero bytes.

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

Returns true if other lies entirely within self.

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

Returns true if self contains the byte offset: start <= offset < end. Zero-width spans never contain anything.

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

Returns true if the two spans share at least one byte.

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

Converts the span to a Range<usize> suitable for slicing source text.

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

impl Debug for Span

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

Formats the value using the given formatter.

impl Display for Span

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

Formats the value using the given formatter.

impl Eq for Span

impl Hash for Span

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Span