Module stream

Expand description

Stream capability for combinators to parse

Stream types include:

&[u8] and Bytes for binary data
&str (aliased as Str) and BStr for UTF-8 data
LocatingSlice can track the location within the original buffer to report spans
Stateful to thread global state through your parsers
Partial can mark an input as partial buffer that is being streamed into
Custom stream types

Structs§

BStr: Improved Debug experience for &[u8] UTF-8-ish streams
BitOffsets: Iterator for bit stream ((I, usize))
Bytes: Improved Debug experience for &[u8] byte streams
Checkpoint: Ensure checkpoint details are kept private
LocatingSlice: Allow collecting the span of a parsed token within a slice
Partial: Mark the input as a partial buffer for streaming input.
Range: A range bounded inclusively for counting parses performed
Recoverableunstable-recover and std: Allow recovering from parse errors, capturing them as the parser continues
Stateful: Thread global state through your parsers
TokenSlice: Specialized input for parsing lexed tokens

Accumulate: Abstracts something which can extend an Extend. Used to build modified input slices in escaped_transform
AsBStr: Helper trait for types that can be viewed as a byte slice
AsBytes: Helper trait for types that can be viewed as a byte slice
AsChar: Transforms a token into a char for basic string parsing
Compare: Abstracts comparison operations
ContainsToken: Check if a token is in a set of possible tokens
FindSlice: Look for a slice in self
Location: Current parse locations offset
Offset: Useful functions to calculate the offset between slices and show a hexdump of a slice
ParseSlice: Used to integrate str’s parse() method
Recoverunstable-recover and std: Capture top-level errors in the middle of parsing so parsing can resume
SliceLen: Abstract method to calculate the input length
Stream: Core definition for parser input state
StreamIsPartial: Marks the input as being the complete buffer or a partial buffer for streaming input
ToUsize: Helper trait to convert numbers to usize.
UpdateSlice: Convert a Stream into an appropriate Output type