Struct nom_grapheme_clusters::Location

pub struct Location { /* private fields */ }

The location in a source code.

Implementations

impl Location

pub fn new(source: Source, position: usize) -> Self

Creates a new location given the source code object and position index.

Panics

Panics if position is past beyond source length in number of segments.

pub fn position(&self) -> usize

This location’s position in the source code in terms of grapheme clusters/segments.

pub fn source(&self) -> &Source

The source code object this location refers to.

pub fn line_column(&self) -> (usize, usize)

Finds the line and column (respectively) of this location in the source code. Line and column count grapheme clusters/segments, not bytes nor characters.

pub fn line(&self) -> usize

Finds the line of this location in the source code. Line counts grapheme clusters/segments, not bytes nor characters.

pub fn column(&self) -> usize

Finds the column of this location in the source code. Column counts grapheme clusters/segments, not bytes nor characters.

pub fn as_str(&self) -> &str

Returns the underlying grapheme cluster segment content at this location.

pub fn segment(&self) -> LocatedSegment

Returns the single segmented pointed by this location.

pub fn line_span(&self) -> Span

Creates a Span containing the whole line this location is in.

Trait Implementations

impl AsRef<Location> for Location

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<str> for Location

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Location

fn clone(&self) -> Location

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Location

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

Formats the value using the given formatter.

impl Display for Location

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

Formats the value using the given formatter.

impl Hash for Location

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 Ord for Location

fn cmp(&self, other: &Location) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Location> for Location

fn eq(&self, other: &Location) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Location> for Location

fn partial_cmp(&self, other: &Location) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Spanned for Location

fn span(&self) -> Span

Returns the span associated with this value.

impl Eq for Location

impl StructuralEq for Location

impl StructuralPartialEq for Location