Struct VecStream

pub struct VecStream { /* private fields */ }

A stream that return Data from a Vec<u8> This can be used if you want give ownership of data to the stream. This allow to return Context that reference Span from Stream

Implementations

impl VecStream

pub fn new(vec: Vec<u8>) -> Self

Return a new VecStream from a Vec<u8>

Trait Implementations

impl AsRef<[u8]> for VecStream

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

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

impl Clone for VecStream

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VecStream

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

Formats the value using the given formatter.

impl PartialEq for VecStream

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

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

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 Streaming for VecStream

type Error = Infallible

Error that a stream can produce

type Item = u8

Item produced by the stream

type Span = VecStream

Span used to represent a delimited part of the stream

fn split_first(self) -> Split<Self::Item, Self, Self::Error>

Will remove the first item from the stream

fn all(self) -> Result<Success<Self::Span, Self>, Self::Error>

Will return all possible Item from the stream, note that again use this with caution.

fn split_at(self, _mid: usize) -> Split<Self, Self, Self::Error>

Will split the stream in half

fn split_last(self) -> Split<Self::Item, Self, Self::Error>

Will remove the last item from the stream, not this is know as backtracking. It’s generally not recommanded to do this, not all stream will be able to implement this

fn diff(self, other: &Self) -> Result<Self::Span, Self>

Allow to get a span between two stream, self must be a stream earlier than other

fn consume(self) -> Self

This should be used with maximum care. This is used to tell to the stream, “drop already read data”. It’s mean all data before the cursor of this stream is gone. It’s invalidate any Stream or Span with cursor that point to purged data. The purpose of this is to avoid keep all data in memory if not needed. This should be call only by end user parser or be documented properly.

impl Eq for VecStream

impl StructuralPartialEq for VecStream