Struct nom_grapheme_clusters::span::Span

pub struct Span { /* private fields */ }

A span (a range) in the source code.

It can be created with the constructor Span::new, or with Source::full_span.

Implementations

impl Span

pub fn new(start: Location, length: usize) -> Self

Creates a new span given the start location and length.

Panics

Panics if length is too big, i.e. start.position() + length > start.source().len().

pub fn from_range(start: Location, end: Location) -> Self

Creates a new span from a range of locations, where end is exlusive.

Panics

Panics if start and end point to different sources, or if start is past beyond end.

pub fn from_range_inclusive(start: Location, end: Location) -> Self

Creates a new span from a range of locations, where end is inclusive.

Panics

Panics if start and end point to different sources, or if start is the same or beyond end.

pub fn start(&self) -> Location

The start location of this span.

pub fn end(&self) -> Location

The end location of this span.

pub fn len(&self) -> usize

The length of this span in string segments.

pub fn source(&self) -> &Source

The source code object this span refers to.

pub fn as_str(&self) -> &str

Gets the string this span includes as a whole.

pub fn content(&self) -> SpanContent

Creates a type that, when displayed, shows the span contents, rather than location.

pub fn expand_lines(&self) -> Span

Expands this span in order to contain the whole lines the original span contains.

pub fn try_slice<R>(&self, range: R) -> Option<Self>where R: RangeBounds<usize>,

Slices this span to the given range. Returns None if the range is invalid.

pub fn segments(&self) -> Segments

Creates an iterator over located grapheme cluster segments, namely LocatedSegments.

pub fn indexed_segments(&self) -> IndexedSegments

Creates an IndexedSegments iterator, which yields a tuple of position and a LocatedSegment in that position. Note that this is just for convenience with e.g. nom, LocatedSegment already contains its position, and so Segments can be used.

Trait Implementations

impl AsRef<Span> for Span

fn as_ref(&self) -> &Self

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

impl AsRef<str> for Span

fn as_ref(&self) -> &str

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

impl Clone for Span

fn clone(&self) -> Span

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'this, 'input> Compare<&'input Span> for &'this Span

fn compare(&self, input: &'input Span) -> CompareResult

Compares self to another value for equality

fn compare_no_case(&self, input: &'input Span) -> CompareResult

Compares self to another value for equality independently of the case.

impl<'this, 'input> Compare<&'input Span> for &'this SpanContent

fn compare(&self, input: &'input Span) -> CompareResult

Compares self to another value for equality

fn compare_no_case(&self, input: &'input Span) -> CompareResult

Compares self to another value for equality independently of the case.

impl<'input> Compare<&'input Span> for Span

fn compare(&self, input: &'input Span) -> CompareResult

Compares self to another value for equality

fn compare_no_case(&self, input: &'input Span) -> CompareResult

Compares self to another value for equality independently of the case.

impl<'input> Compare<&'input Span> for SpanContent

fn compare(&self, input: &'input Span) -> CompareResult

Compares self to another value for equality

fn compare_no_case(&self, input: &'input Span) -> CompareResult

Compares self to another value for equality independently of the case.

impl<'this, 'input> Compare<&'input SpanContent> for &'this Span

fn compare(&self, input: &'input SpanContent) -> CompareResult

Compares self to another value for equality

fn compare_no_case(&self, input: &'input SpanContent) -> CompareResult

Compares self to another value for equality independently of the case.

impl<'input> Compare<&'input SpanContent> for Span

fn compare(&self, input: &'input SpanContent) -> CompareResult

Compares self to another value for equality

fn compare_no_case(&self, input: &'input SpanContent) -> CompareResult

Compares self to another value for equality independently of the case.

impl<'slice, 'seg, 'span> Compare<&'span Span> for Tag<'slice, 'seg>

fn compare(&self, input: &'span Span) -> CompareResult

Compares self to another value for equality

fn compare_no_case(&self, input: &'span Span) -> CompareResult

Compares self to another value for equality independently of the case.

impl<'slice, 'seg, 'tag, 'span> Compare<&'tag Tag<'slice, 'seg>> for &'span Span

fn compare(&self, input: &'tag Tag<'slice, 'seg>) -> CompareResult

Compares self to another value for equality

fn compare_no_case(&self, input: &'tag Tag<'slice, 'seg>) -> CompareResult

Compares self to another value for equality independently of the case.

impl<'slice, 'seg, 'tag> Compare<&'tag Tag<'slice, 'seg>> for Span

fn compare(&self, input: &'tag Tag<'slice, 'seg>) -> CompareResult

Compares self to another value for equality

fn compare_no_case(&self, input: &'tag Tag<'slice, 'seg>) -> CompareResult

Compares self to another value for equality independently of the case.

impl<'this> Compare<Span> for &'this Span

fn compare(&self, input: Span) -> CompareResult

Compares self to another value for equality

fn compare_no_case(&self, input: Span) -> CompareResult

Compares self to another value for equality independently of the case.

impl<'this> Compare<Span> for &'this SpanContent

fn compare(&self, input: Span) -> CompareResult

Compares self to another value for equality

fn compare_no_case(&self, input: Span) -> CompareResult

Compares self to another value for equality independently of the case.

impl Compare<Span> for Span

fn compare(&self, input: Span) -> CompareResult

Compares self to another value for equality

fn compare_no_case(&self, input: Span) -> CompareResult

Compares self to another value for equality independently of the case.

impl Compare<Span> for SpanContent

fn compare(&self, input: Span) -> CompareResult

Compares self to another value for equality

fn compare_no_case(&self, input: Span) -> CompareResult

Compares self to another value for equality independently of the case.

impl<'slice, 'seg, 'span> Compare<Span> for Tag<'slice, 'seg>

fn compare(&self, input: Span) -> CompareResult

Compares self to another value for equality

fn compare_no_case(&self, input: Span) -> CompareResult

Compares self to another value for equality independently of the case.

impl<'this> Compare<SpanContent> for &'this Span

fn compare(&self, input: SpanContent) -> CompareResult

Compares self to another value for equality

fn compare_no_case(&self, input: SpanContent) -> CompareResult

Compares self to another value for equality independently of the case.

impl Compare<SpanContent> for Span

fn compare(&self, input: SpanContent) -> CompareResult

Compares self to another value for equality

fn compare_no_case(&self, input: SpanContent) -> CompareResult

Compares self to another value for equality independently of the case.

impl<'slice, 'seg, 'span> Compare<Tag<'slice, 'seg>> for &'span Span

fn compare(&self, input: Tag<'slice, 'seg>) -> CompareResult

Compares self to another value for equality

fn compare_no_case(&self, input: Tag<'slice, 'seg>) -> CompareResult

Compares self to another value for equality independently of the case.

impl<'slice, 'seg> Compare<Tag<'slice, 'seg>> for Span

fn compare(&self, input: Tag<'slice, 'seg>) -> CompareResult

Compares self to another value for equality

fn compare_no_case(&self, input: Tag<'slice, 'seg>) -> CompareResult

Compares self to another value for equality independently of the case.

impl Debug for Span

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

Formats the value using the given formatter.

impl Display for Span

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

Formats the value using the given formatter.

impl<'this, 'tok> FindToken<&'tok LocatedSegment> for &'this Span

fn find_token(&self, token: &'tok LocatedSegment) -> bool

Returns true if self contains the token

impl<'tok> FindToken<&'tok LocatedSegment> for Span

fn find_token(&self, token: &'tok LocatedSegment) -> bool

Returns true if self contains the token

impl<'this, 'tok> FindToken<&'tok str> for &'this Span

fn find_token(&self, token: &'tok str) -> bool

Returns true if self contains the token

impl<'tok> FindToken<&'tok str> for Span

fn find_token(&self, token: &'tok str) -> bool

Returns true if self contains the token

impl<'this, 'tok, 'tok_ref> FindToken<&'tok_ref &'tok str> for &'this Span

fn find_token(&self, token: &'tok_ref &'tok str) -> bool

Returns true if self contains the token

impl<'tok, 'tok_ref> FindToken<&'tok_ref &'tok str> for Span

fn find_token(&self, token: &'tok_ref &'tok str) -> bool

Returns true if self contains the token

impl<'this, 'tok> FindToken<LocatedSegment> for &'this Span

fn find_token(&self, token: LocatedSegment) -> bool

Returns true if self contains the token

impl<'tok> FindToken<LocatedSegment> for Span

fn find_token(&self, token: LocatedSegment) -> bool

Returns true if self contains the token

impl Hash for Span

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

type Item = LocatedSegment

The current input type is a sequence of that Item type.

type Iter = Enumerate<<Span as InputIter>::IterElem>

An iterator over the input type, producing the item and its position for use with Slice. If we’re iterating over &str, the position corresponds to the byte index of the character

type IterElem = Segments

An iterator over the input type, producing the item

fn iter_indices(&self) -> Self::Iter

Returns an iterator over the elements and their byte offsets

fn iter_elements(&self) -> Self::IterElem

Returns an iterator over the elements

fn position<P>(&self, predicate: P) -> Option<usize>where P: Fn(Self::Item) -> bool,

Finds the byte position of the element

fn slice_index(&self, count: usize) -> Result<usize, Needed>

Get the byte offset from the element’s position in the stream

impl<'this> InputLength for &'this Span

fn input_len(&self) -> usize

Calculates the input length, as indicated by its name, and the name of the trait itself

impl InputLength for Span

fn input_len(&self) -> usize

Calculates the input length, as indicated by its name, and the name of the trait itself

impl InputTake for Span

fn take(&self, count: usize) -> Self

Returns a slice of count bytes. panics if count > length

fn take_split(&self, count: usize) -> (Self, Self)

Split the stream at the count byte offset. panics if count > length

impl InputTakeAtPosition for Span

type Item = LocatedSegment

The current input type is a sequence of that Item type.

fn split_at_position<P, E>(&self, predicate: P) -> IResult<Self, Self, E>where P: Fn(Self::Item) -> bool, E: ParseError<Self>,

Looks for the first element of the input type for which the condition returns true, and returns the input up to this position.

fn split_at_position1<P, E>( &self, predicate: P, e: ErrorKind ) -> IResult<Self, Self, E>where P: Fn(Self::Item) -> bool, E: ParseError<Self>,

Looks for the first element of the input type for which the condition returns true and returns the input up to this position.

fn split_at_position_complete<P, E>( &self, predicate: P ) -> IResult<Self, Self, E>where P: Fn(Self::Item) -> bool, E: ParseError<Self>,

Looks for the first element of the input type for which the condition returns true, and returns the input up to this position.

fn split_at_position1_complete<P, E>( &self, predicate: P, e: ErrorKind ) -> IResult<Self, Self, E>where P: Fn(Self::Item) -> bool, E: ParseError<Self>,

Looks for the first element of the input type for which the condition returns true and returns the input up to this position.

impl IntoIterator for Span

type Item = LocatedSegment

The type of the elements being iterated over.

type IntoIter = Segments

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Offset for Span

fn offset(&self, second: &Self) -> usize

Offset between the first byte of self and the first byte of the argument

impl Ord for Span

fn cmp(&self, other: &Span) -> 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<Span> for Span

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

fn partial_cmp(&self, other: &Span) -> 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<R> Slice<R> for Spanwhere R: RangeBounds<usize> + Debug + Clone,

fn slice(&self, range: R) -> Self

Slices self according to the range argument

impl Spanned for Span

fn span(&self) -> Span

Returns the span associated with this value.

impl Eq for Span

impl StructuralEq for Span

impl StructuralPartialEq for Span