Struct winnow::stream::Partial

source ·
pub struct Partial<I> { /* private fields */ }
Expand description

Mark the input as a partial buffer for streaming input.

Complete input means that we already have all of the data. This will be the common case with small files that can be read entirely to memory.

In contrast, streaming input assumes that we might not have all of the data. This can happen with some network protocol or large file parsers, where the input buffer can be full and need to be resized or refilled.

  • [ErrMode::Incomplete] will report how much more data is needed.
  • Parser::complete_err transform [ErrMode::Incomplete] to [ErrMode::Backtrack]

See also StreamIsPartial to tell whether the input supports complete or partial parsing.

See also [Special Topics: Parsing Partial Input][crate::_topic::partial].

§Example

Here is how it works in practice:


fn take_partial<'s>(i: &mut Partial<&'s [u8]>) -> PResult<&'s [u8], InputError<Partial<&'s [u8]>>> {
  token::take(4u8).parse_next(i)
}

fn take_complete<'s>(i: &mut &'s [u8]) -> PResult<&'s [u8], InputError<&'s [u8]>> {
  token::take(4u8).parse_next(i)
}

// both parsers will take 4 bytes as expected
assert_eq!(take_partial.parse_peek(Partial::new(&b"abcde"[..])), Ok((Partial::new(&b"e"[..]), &b"abcd"[..])));
assert_eq!(take_complete.parse_peek(&b"abcde"[..]), Ok((&b"e"[..], &b"abcd"[..])));

// if the input is smaller than 4 bytes, the partial parser
// will return `Incomplete` to indicate that we need more data
assert_eq!(take_partial.parse_peek(Partial::new(&b"abc"[..])), Err(ErrMode::Incomplete(Needed::new(1))));

// but the complete parser will return an error
assert_eq!(take_complete.parse_peek(&b"abc"[..]), Err(ErrMode::Backtrack(InputError::new(&b"abc"[..], ErrorKind::Slice))));

// the alpha0 function recognizes 0 or more alphabetic characters
fn alpha0_partial<'s>(i: &mut Partial<&'s str>) -> PResult<&'s str, InputError<Partial<&'s str>>> {
  ascii::alpha0.parse_next(i)
}

fn alpha0_complete<'s>(i: &mut &'s str) -> PResult<&'s str, InputError<&'s str>> {
  ascii::alpha0.parse_next(i)
}

// if there's a clear limit to the recognized characters, both parsers work the same way
assert_eq!(alpha0_partial.parse_peek(Partial::new("abcd;")), Ok((Partial::new(";"), "abcd")));
assert_eq!(alpha0_complete.parse_peek("abcd;"), Ok((";", "abcd")));

// but when there's no limit, the partial version returns `Incomplete`, because it cannot
// know if more input data should be recognized. The whole input could be "abcd;", or
// "abcde;"
assert_eq!(alpha0_partial.parse_peek(Partial::new("abcd")), Err(ErrMode::Incomplete(Needed::new(1))));

// while the complete version knows that all of the data is there
assert_eq!(alpha0_complete.parse_peek("abcd"), Ok(("", "abcd")));

Implementations§

source§

impl<I> Partial<I>
where I: StreamIsPartial,

source

pub fn new(input: I) -> Self

Create a partial input

source

pub fn into_inner(self) -> I

Extract the original Stream

Trait Implementations§

source§

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

source§

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

Casts the input type to a byte slice
source§

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

source§

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

Casts the input type to a byte slice
source§

impl<I: Clone> Clone for Partial<I>

source§

fn clone(&self) -> Partial<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
source§

impl<I, T> Compare<T> for Partial<I>
where I: Compare<T>,

source§

fn compare(&self, t: T) -> CompareResult

Compares self to another value for equality
source§

fn compare_no_case(&self, t: T) -> CompareResult

Compares self to another value for equality independently of the case. Read more
source§

impl<I: Debug> Debug for Partial<I>

source§

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

Formats the value using the given formatter. Read more
source§

impl<I> Default for Partial<I>

source§

fn default() -> Self

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

impl<I> Deref for Partial<I>

§

type Target = I

The resulting type after dereferencing.
source§

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

Dereferences the value.
source§

impl<I: Display> Display for Partial<I>

source§

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

Formats the value using the given formatter. Read more
source§

impl<I, T> FindSlice<T> for Partial<I>
where I: FindSlice<T>,

source§

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

Returns the offset of the slice if it is found
source§

impl<I> Location for Partial<I>
where I: Location,

source§

fn location(&self) -> usize

Number of indices input has advanced since start of parsing
source§

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

source§

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

Offset between the first byte of start and the first byte of self
source§

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

source§

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

Offset between the first byte of start and the first byte of self
source§

impl<I: Ord> Ord for Partial<I>

source§

fn cmp(&self, other: &Partial<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 + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl<I: PartialEq> PartialEq for Partial<I>

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl<I: PartialOrd> PartialOrd for Partial<I>

source§

fn partial_cmp(&self, other: &Partial<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

This method 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

This method 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

This method 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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl<I> SliceLen for Partial<I>
where I: SliceLen,

source§

fn slice_len(&self) -> usize

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

impl<I: Stream> Stream for Partial<I>

§

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>

A parse location within the stream
source§

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

Iterate with the offset from the current location
source§

fn eof_offset(&self) -> usize

Returns the offaet to the end of the input
source§

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

Split off the next token from the input
source§

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

Finds the offset of the next matching token
source§

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

Get the offset for the number of tokens into the stream Read more
source§

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

Split off a slice of tokens from the input Read more
source§

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

Save the current parse location within the stream
source§

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

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

fn raw(&self) -> &dyn Debug

Return the inner-most stream
source§

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

Advance to the end of the stream
source§

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

§

type PartialState = bool

Whether the stream is currently partial or complete
source§

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

Mark the stream is complete
source§

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

Restore the stream back to its previous state
source§

fn is_partial_supported() -> bool

Report whether the Stream is can ever be incomplete
source§

fn is_partial(&self) -> bool

Report whether the Stream is currently incomplete
source§

impl<I> UpdateSlice for Partial<I>
where I: UpdateSlice,

source§

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

Convert an Output type to be used as Stream
source§

impl<I: Copy> Copy for Partial<I>

source§

impl<I: Eq> Eq for Partial<I>

source§

impl<I> StructuralPartialEq for Partial<I>

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

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

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

source§

fn into(self) -> U

Calls U::from(self).

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

source§

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

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

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

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

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

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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.
source§

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

Performs the conversion.