Struct kul_core::text::chunk::premade::PosStr

pub struct PosStr<'s> {
    pub val: &'s str,
    pub pos: StrPos<'s>,
}

A TextChunk implementation for borrowed string slices (&str) that knows what position in its original source string it is at. This is useful for zero-copy parsing of in-memory UTF-8 strings.

Note: The comparison traits are not implemented intentionally, because this is intended as a chunk type and comparing those directly shouldn't be done.

Fields

val: &'s str

The represented string slice.

pos: StrPos<'s>

Information about val's position relative to its original source.

Trait Implementations

impl<'s> TextBase for PosStr<'s>

type Pos = StrPos<'s>

Positional information used with our chunks and chars.

fn empty() -> Self

Make an empty one.

fn is_empty(&self) -> bool

Predicate for if an instance is an empty one.

impl<'s> SourceStream<PosStr<'s>> for PosStrIter<'s>

Enables PosStr to be used as the Chunk type of Text types that implement TextConcat so they can be iterated with kul_core::SourceStream. A chunk::SourceStream can accumulate what it iterates within a single chunk. This simply records and grows a slice, to represent each accumulation, which is zero-copy.

fn peek(&mut self) -> Option<&SourceIterItem<StrPos<'s>>>

Returns a reference to the next item's value without advancing the iterator and without interfering with any pending accumulation.

fn next_accum(&mut self) -> Option<SourceIterItem<StrPos<'s>>>

Get the next item, if any, and add it to a pending, or start a new, accumulation, and return the item.

fn accum_done(&mut self) -> PosStr<'s>

Take any pending accumulation and return it as a new chunk, or return an empty chunk if there was nothing pending.

impl<'s> TextChunk for PosStr<'s>

type CharsSrcStrm = PosStrIter<'s>

Our chunk::SourceStream type.

fn src_strm(&self) -> Self::CharsSrcStrm

Construct a new iterator, which is also a chunk::SourceStream, that yields the character sequence, and their positions, of the given self chunk.

impl<'s> Debug for PosStr<'s>

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

Formats the value using the given formatter.

impl<'s1, 's2> From<&'s2 str> for PosStr<'s1> where
    's2: 's1, 

fn from(val: &'s2 str) -> Self

Performs the conversion.

impl<'s> Copy for PosStr<'s>

impl<'s> Clone for PosStr<'s>

fn clone(&self) -> PosStr<'s>

Returns a copy of the value.

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

Performs copy-assignment from source.