Trait chumsky::span::Span

pub trait Span: Clone {
    type Context: Clone;
    type Offset: Clone;
    fn new(context: Self::Context, range: Range<Self::Offset>) -> Self;
    fn context(&self) -> Self::Context;
    fn start(&self) -> Self::Offset;
    fn end(&self) -> Self::Offset;
}

A trait that describes a span over a particular range of inputs.

Spans typically consist of some context, such as the file they originated from, and a start/end offset. Spans are permitted to overlap one-another. The end offset must always be greater than or equal to the end offset.

Associated Types

type Context: Clone

The context that comes packaged with a span. This is usually some way to uniquely identity the source file that a span originated in. However, it has no inherent meaning to the parser and can be anything. Range<usize>’s implementation of Span simply has a context of ().

type Offset: Clone

A type representing a span’s start or end offset. Typically, usize is used.

Required methods

fn new(context: Self::Context, range: Range<Self::Offset>) -> Self

Create a new span given a context and an offset range.

fn context(&self) -> Self::Context

Return the span’s context.

fn start(&self) -> Self::Offset

Return the start offset of the span.

fn end(&self) -> Self::Offset

Return the end offset of the span.

Implementations on Foreign Types

impl<T: Clone + Ord> Span for Range<T>

type Context = ()

type Offset = T

fn new((): Self::Context, range: Self) -> Self

fn context(&self) -> Self::Context

fn start(&self) -> Self::Offset

fn end(&self) -> Self::Offset

impl<S: Clone, T: Clone> Span for (S, Range<T>)

type Context = S

type Offset = T

fn new(context: Self::Context, range: Range<T>) -> Self

fn context(&self) -> Self::Context

fn start(&self) -> Self::Offset

fn end(&self) -> Self::Offset

Implementors