devela::_dep::winnow::stream

Struct LocatingSlice

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

Available on crate feature dep_winnow only.

Expand description

Allow collecting the span of a parsed token within a slice

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> LocatingSlice<I>
where I: Clone + Offset,

pub fn new(input: I) -> LocatingSlice<I>

Wrap another Stream with span tracking

impl<I> LocatingSlice<I>
where I: Clone + Stream + Offset,

pub fn reset_to_start(&mut self)

Reset the stream to the start

This is useful for formats that encode a graph with addresses relative to the start of the input.

Trait Implementations§

impl<I> AsBStr for LocatingSlice<I>
where I: AsBStr,

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

Casts the input type to a byte slice

impl<I> AsBytes for LocatingSlice<I>
where I: AsBytes,

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

Casts the input type to a byte slice

impl<I> AsRef<I> for LocatingSlice<I>

fn as_ref(&self) -> &I

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

impl<I> Clone for LocatingSlice<I>
where I: Clone,

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

Returns a copy of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl<I, U> Compare<U> for LocatingSlice<I>
where I: Compare<U>,

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

Compares self to another value for equality

impl<I> Debug for LocatingSlice<I>
where I: Debug,

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

Formats the value using the given formatter. Read more

impl<I> Default for LocatingSlice<I>
where I: Default,

fn default() -> LocatingSlice<I>

Returns the “default value” for a type. Read more

impl<I> Deref for LocatingSlice<I>

type Target = I

The resulting type after dereferencing.

fn deref(&self) -> &<LocatingSlice<I> as Deref>::Target

Dereferences the value.

impl<I> Display for LocatingSlice<I>
where I: Display,

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

Formats the value using the given formatter. Read more

impl<I, T> FindSlice<T> for LocatingSlice<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 LocatingSlice<I>
where I: Clone + Offset,

fn location(&self) -> usize ⓘ

Number of indices input has advanced since start of parsing

impl<I> Offset<<LocatingSlice<I> as Stream>::Checkpoint> for LocatingSlice<I>
where I: Stream,

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

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

impl<I> Offset for LocatingSlice<I>
where I: Stream,

fn offset_from(&self, other: &LocatingSlice<I>) -> usize ⓘ

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

impl<I> Ord for LocatingSlice<I>
where I: Ord,

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

This method returns an Ordering between self and other. Read more

1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more

1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more

1.50.0 · Source§

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

Restrict a value to a certain interval. Read more

impl<I> PartialEq for LocatingSlice<I>
where I: PartialEq,

fn eq(&self, other: &LocatingSlice<I>) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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<I> PartialOrd for LocatingSlice<I>
where I: PartialOrd,

fn partial_cmp(&self, other: &LocatingSlice<I>) -> Option<Ordering> ⓘ

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

1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more

impl<I> SliceLen for LocatingSlice<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 for LocatingSlice<I>
where I: Stream,

type Token = <I as Stream>::Token

The smallest unit being parsed Read more

type Slice = <I as Stream>::Slice

Sequence of Tokens Read more

type IterOffsets = <I as Stream>::IterOffsets

Iterate with the offset from the current location

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

A parse location within the stream

fn iter_offsets(&self) -> <LocatingSlice<I> as Stream>::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<<LocatingSlice<I> as Stream>::Token> ⓘ

Split off the next token from the input

fn offset_for<P>(&self, predicate: P) -> Option<usize> ⓘ
where P: Fn(<LocatingSlice<I> as Stream>::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 Read more

fn next_slice(&mut self, offset: usize) -> <LocatingSlice<I> as Stream>::Slice

Split off a slice of tokens from the input Read more

fn checkpoint(&self) -> <LocatingSlice<I> as Stream>::Checkpoint

Save the current parse location within the stream

fn reset(&mut self, checkpoint: &<LocatingSlice<I> as Stream>::Checkpoint)

Revert the stream to a prior Self::Checkpoint Read more

fn raw(&self) -> &dyn Debug

Return the inner-most stream

fn peek_token(&self) -> Option<(Self, Self::Token)> ⓘ
where Self: Clone,

Split off the next token from the input

fn peek_slice(&self, offset: usize) -> (Self, Self::Slice) ⓘ
where Self: Clone,

Split off a slice of tokens from the input

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

Advance to the end of the stream

fn peek_finish(&self) -> (Self, Self::Slice) ⓘ
where Self: Clone,

Advance to the end of the stream

impl<I> StreamIsPartial for LocatingSlice<I>
where I: StreamIsPartial,

type PartialState = <I as StreamIsPartial>::PartialState

Whether the stream is currently partial or complete

fn complete(&mut self) -> <LocatingSlice<I> as StreamIsPartial>::PartialState

Mark the stream is complete

fn restore_partial( &mut self, state: <LocatingSlice<I> as StreamIsPartial>::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 LocatingSlice<I>
where I: UpdateSlice,

fn update_slice( self, inner: <LocatingSlice<I> as Stream>::Slice, ) -> LocatingSlice<I>

Convert an Output type to be used as Stream

impl<I> Copy for LocatingSlice<I>
where I: Copy,

impl<I> Eq for LocatingSlice<I>
where I: Eq,

impl<I> StructuralPartialEq for LocatingSlice<I>

Auto Trait Implementations§

impl<I> Freeze for LocatingSlice<I>
where I: Freeze,

impl<I> RefUnwindSafe for LocatingSlice<I>
where I: RefUnwindSafe,

impl<I> Send for LocatingSlice<I>
where I: Send,

impl<I> Sync for LocatingSlice<I>
where I: Sync,

impl<I> Unpin for LocatingSlice<I>
where I: Unpin,

impl<I> UnwindSafe for LocatingSlice<I>
where I: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> ArchivePointee for T

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> ByteSized for T

const BYTE_ALIGN: usize = _

The alignment of this type in bytes.

const BYTE_SIZE: usize = _

The size of this type in bytes.

fn byte_align(&self) -> usize ⓘ

Returns the alignment of this type in bytes.

fn byte_size(&self) -> usize ⓘ

Returns the size of this type in bytes. Read more

fn ptr_size_ratio(&self) -> [usize; 2]

Returns the size ratio between Ptr::BYTES and BYTE_SIZE. Read more

impl<T, R> Chain<R> for T
where T: ?Sized,

fn chain<F>(self, f: F) -> R
where F: FnOnce(Self) -> R, Self: Sized,

Chain a function which takes the parameter by value.

fn chain_ref<F>(&self, f: F) -> R
where F: FnOnce(&Self) -> R,

Chain a function which takes the parameter by shared reference.

fn chain_mut<F>(&mut self, f: F) -> R
where F: FnOnce(&mut Self) -> R,

Chain a function which takes the parameter by exclusive reference.

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> ExtAny for T
where T: Any + ?Sized,

fn type_id() -> TypeId

Returns the TypeId of Self. Read more

fn type_of(&self) -> TypeId

Returns the TypeId of self. Read more

fn type_name(&self) -> &'static str ⓘ

Returns the type name of self. Read more

fn type_is<T: 'static>(&self) -> bool

Returns true if Self is of type T. Read more

fn as_any_ref(&self) -> &dyn Any
where Self: Sized,

Upcasts &self as &dyn Any. Read more

fn as_any_mut(&mut self) -> &mut dyn Any
where Self: Sized,

Upcasts &mut self as &mut dyn Any. Read more

fn as_any_box(self: Box<Self>) -> Box<dyn Any>
where Self: Sized,

Upcasts Box<self> as Box<dyn Any>. Read more

fn downcast_ref<T: 'static>(&self) -> Option<&T> ⓘ

Available on crate feature unsafe_layout only.

Returns some shared reference to the inner value if it is of type T. Read more

fn downcast_mut<T: 'static>(&mut self) -> Option<&mut T> ⓘ

Available on crate feature unsafe_layout only.

Returns some exclusive reference to the inner value if it is of type T. Read more

impl<T> ExtMem for T
where T: ?Sized,

const NEEDS_DROP: bool = _

Know whether dropping values of this type matters, in compile-time.

fn mem_align_of<T>() -> usize ⓘ

Returns the minimum alignment of the type in bytes. Read more

fn mem_align_of_val(&self) -> usize ⓘ

Returns the alignment of the pointed-to value in bytes. Read more

fn mem_size_of<T>() -> usize ⓘ

Returns the size of a type in bytes. Read more

fn mem_size_of_val(&self) -> usize ⓘ

Returns the size of the pointed-to value in bytes. Read more

fn mem_copy(&self) -> Self
where Self: Copy,

Bitwise-copies a value. Read more

fn mem_needs_drop(&self) -> bool

Returns true if dropping values of this type matters. Read more

fn mem_drop(self)
where Self: Sized,

Drops self by running its destructor. Read more

fn mem_forget(self)
where Self: Sized,

Forgets about self without running its destructor. Read more

fn mem_replace(&mut self, other: Self) -> Self
where Self: Sized,

Replaces self with other, returning the previous value of self. Read more

fn mem_take(&mut self) -> Self
where Self: Default,

Replaces self with its default value, returning the previous value of self. Read more

fn mem_swap(&mut self, other: &mut Self)
where Self: Sized,

Swaps the value of self and other without deinitializing either one. Read more

unsafe fn mem_zeroed<T>() -> T

Available on crate feature unsafe_layout only.

Returns the value of type T represented by the all-zero byte-pattern. Read more

unsafe fn mem_transmute_copy<Src, Dst>(src: &Src) -> Dst

Available on crate feature unsafe_layout only.

Returns the value of type T represented by the all-zero byte-pattern. Read more

fn mem_as_bytes(&self) -> &[u8] ⓘ
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.

View a Sync + Unpin self as &[u8]. Read more

fn mem_as_bytes_mut(&mut self) -> &mut [u8] ⓘ
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.

View a Sync + Unpin self as &mut [u8]. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<S> FromSample<S> for S

fn from_sample_(s: S) -> S

impl<T> Hook for T

fn hook_ref<F>(self, f: F) -> Self
where F: FnOnce(&Self),

Applies a function which takes the parameter by shared reference, and then returns the (possibly) modified owned value. Read more

fn hook_mut<F>(self, f: F) -> Self
where F: FnOnce(&mut Self),

Applies a function which takes the parameter by exclusive reference, and then returns the (possibly) modified owned value. Read more

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

fn into_sample(self) -> T

impl<T> LayoutRaw for T

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError> ⓘ

Returns the layout of the type.

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize ⓘ

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Pointee for T

type Metadata = ()

The metadata type for pointers and references to this type.

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)

The target type on which the method may be called.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

fn to_sample_(self) -> U

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String ⓘ

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error> ⓘ

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error> ⓘ

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

impl<T> Ungil for T
where T: Send,