Struct Span

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

Semantic type for file-position ranges.

Spans will generally not be empty. An empty span at position 0 is called a null span used as a sentinel value by several functions.

Fields

start: FilePos

Index of first character of the range.

end: FilePos

Index one past last character of the range.

Implementations

impl Span

pub const NULL: Span

Returns the null span.

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

Coercion from array index pairs.

pub const fn new2(start: FilePos, end: FilePos) -> Span

Variant on new taking FilePos values.

pub const fn is_null(self) -> bool

Checks for the null span, i.e. zero length at offset zero.

pub const fn len(self) -> usize

Get the length of the span.

pub const fn is_empty(self) -> bool

Is this an empty span?

pub fn as_ref(self, buf: &[u8]) -> &[u8]

Given a position span, extract the corresponding characters from a buffer.

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 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