Struct winnow::stream::Located

pub struct Located<I> { /* private fields */ }

Allow collecting the span of a parsed token

Spans are tracked as a Range<usize> of byte offsets.

Converting byte offsets to line or column numbers is left up to the user, as computing column numbers requires domain knowledge (are columns byte-based, codepoint-based, or grapheme-based?) and O(n) iteration over the input to determine codepoint and line boundaries.

The line-span crate can help with converting byte offsets to line numbers.

See Parser::span and Parser::with_span for more details

Implementations

impl<I> Located<I>

where I: Clone + Offset,

pub fn new(input: I) -> Self

Wrap another Stream with span tracking

Trait Implementations

impl<I> AsBStr for Located<I>

where I: AsBStr,

fn as_bstr(&self) -> &[u8]

Casts the input type to a byte slice

impl<I> AsBytes for Located<I>

where I: AsBytes,

fn as_bytes(&self) -> &[u8]

Casts the input type to a byte slice

impl<I> AsRef<I> for Located<I>

fn as_ref(&self) -> &I

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

impl<I: Clone> Clone for Located<I>

fn clone(&self) -> Located<I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I, U> Compare<U> for Located<I>

where I: Compare<U>,

fn compare(&self, other: U) -> CompareResult

Compares self to another value for equality

impl<I: Debug> Debug for Located<I>

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

Formats the value using the given formatter.

impl<I: Default> Default for Located<I>

fn default() -> Located<I>

Returns the “default value” for a type.

impl<I> Deref for Located<I>

type Target = I

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<I: Display> Display for Located<I>

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

Formats the value using the given formatter.

impl<I, T> FindSlice<T> for Located<I>

where I: FindSlice<T>,

fn find_slice(&self, substr: T) -> Option<Range<usize>>

Returns the offset of the slice if it is found

impl<I> Location for Located<I>

where I: Clone + Offset,

fn location(&self) -> usize

Number of indices input has advanced since start of parsing

impl<I> Offset<<Located<I> as Stream>::Checkpoint> for Located<I>

where I: Stream,

fn offset_from(&self, other: &<Located<I> as Stream>::Checkpoint) -> usize

Offset between the first byte of start and the first byte of selfa

impl<I> Offset for Located<I>

where I: Stream,

fn offset_from(&self, other: &Self) -> usize

Offset between the first byte of start and the first byte of selfa

impl<I: Ord> Ord for Located<I>

fn cmp(&self, other: &Located<I>) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<I: PartialEq> PartialEq for Located<I>

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

fn partial_cmp(&self, other: &Located<I>) -> 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<I> SliceLen for Located<I>

where I: SliceLen,

fn slice_len(&self) -> usize

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

impl<I: Stream> Stream for Located<I>

type Token = <I as Stream>::Token

The smallest unit being parsed

type Slice = <I as Stream>::Slice

Sequence of Tokens

type IterOffsets = <I as Stream>::IterOffsets

Iterate with the offset from the current location

type Checkpoint = Checkpoint<<I as Stream>::Checkpoint, Located<I>>

A parse location within the stream

fn iter_offsets(&self) -> Self::IterOffsets

Iterate with the offset from the current location

fn eof_offset(&self) -> usize

Returns the offset to the end of the input

fn next_token(&mut self) -> Option<Self::Token>

Split off the next token from the input

fn offset_for<P>(&self, predicate: P) -> Option<usize>

where P: Fn(Self::Token) -> bool,

Finds the offset of the next matching token

fn offset_at(&self, tokens: usize) -> Result<usize, Needed>

Get the offset for the number of tokens into the stream

fn next_slice(&mut self, offset: usize) -> Self::Slice

Split off a slice of tokens from the input

fn checkpoint(&self) -> Self::Checkpoint

Save the current parse location within the stream

fn reset(&mut self, checkpoint: &Self::Checkpoint)

Revert the stream to a prior Self::Checkpoint

fn raw(&self) -> &dyn Debug

Return the inner-most stream

fn finish(&mut self) -> Self::Slice

Advance to the end of the stream

impl<I> StreamIsPartial for Located<I>

where I: StreamIsPartial,

type PartialState = <I as StreamIsPartial>::PartialState

Whether the stream is currently partial or complete

fn complete(&mut self) -> Self::PartialState

Mark the stream is complete

fn restore_partial(&mut self, state: Self::PartialState)

Restore the stream back to its previous state

fn is_partial_supported() -> bool

Report whether the Stream is can ever be incomplete

fn is_partial(&self) -> bool

Report whether the Stream is currently incomplete

impl<I> UpdateSlice for Located<I>

where I: UpdateSlice,

fn update_slice(self, inner: Self::Slice) -> Self

Convert an Output type to be used as Stream

impl<I: Copy> Copy for Located<I>

impl<I: Eq> Eq for Located<I>

impl<I> StructuralPartialEq for Located<I>