Struct LocatedSpan

pub struct LocatedSpan<Span, T = ()> {
    pub extra: T,
    /* private fields */
}

Code span together with information related to where it is located in the code.

This type is similar to one from the nom_locate crate, but it has slightly different functionality. In particular, this type provides no method to access other parts of the code (which is performed in nom_locate’s LocatedSpan::get_column() among other methods). As such, this allows to safely replace span info without worrying about undefined behavior.

Fields

extra: T

Extra information that can be embedded by the user.

Implementations

impl<Span, T> LocatedSpan<Span, T>

pub fn location_offset(&self) -> usize

The offset represents the position of the fragment relatively to the input of the parser. It starts at offset 0.

pub fn location_line(&self) -> u32

The line number of the fragment relatively to the input of the parser. It starts at line 1.

pub fn get_column(&self) -> usize

The column of the fragment start.

pub fn fragment(&self) -> &Span

The fragment that is spanned. The fragment represents a part of the input of the parser.

pub fn map_extra<U>(self, map_fn: impl FnOnce(T) -> U) -> LocatedSpan<Span, U>

Maps the extra field of this span using the provided closure.

pub fn map_fragment<U>( self, map_fn: impl FnOnce(Span) -> U, ) -> LocatedSpan<U, T>

Maps the fragment field of this span using the provided closure.

impl<Span: Copy, T> LocatedSpan<Span, T>

pub fn as_ref(&self) -> LocatedSpan<Span, &T>

Returns a copy of this span with borrowed extra field.

pub fn copy_with_extra<U>(&self, value: U) -> LocatedSpan<Span, U>

Copies this span with the provided extra field.

pub fn with_no_extra(&self) -> LocatedSpan<Span>

Removes extra field from this span.

impl<'a> LocatedSpan<&'a str>

pub fn from_str<R>(code: &'a str, range: R) -> Self

where InputSpan<'a>: Slice<R>,

Creates a span from a range in the provided code. This is mostly useful for testing.

impl<'a> LocatedSpan<CodeFragment<'a>>

pub fn from_str<R>(code: &'a str, range: R) -> Self

where InputSpan<'a>: Slice<R>,

Creates a span from a range in the provided code. This is mostly useful for testing.

impl<T> LocatedSpan<CodeFragment<'_>, T>

pub fn code_or_location(&self, default_name: &str) -> String

Returns either the original code fragment (if it’s retained), or a string in the form {default_name} at {line}:{column}.

Trait Implementations

impl<Span: Clone, T: Clone> Clone for LocatedSpan<Span, T>

fn clone(&self) -> LocatedSpan<Span, T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Span: Debug, T: Debug> Debug for LocatedSpan<Span, T>

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

Formats the value using the given formatter.

impl<'a, T> From<LocatedSpan<&'a str, T>> for LocatedSpan<&'a str, T>

fn from(value: LocatedSpan<&'a str, T>) -> Self

Converts to this type from the input type.

impl<'a, T> From<LocatedSpan<&'a str, T>> for MaybeSpanned<'a, T>

fn from(value: Spanned<'a, T>) -> Self

Converts to this type from the input type.

impl<Span: PartialEq, T> PartialEq for LocatedSpan<Span, T>

fn eq(&self, other: &Self) -> 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<Span: Copy, T: Copy> Copy for LocatedSpan<Span, T>