Module primitives

Module containing the primitive types which is used to create and compose more advanced parsers

Structs

BytePosition

Struct which represents a position in a byte stream

IteratorStream

Wrapper around iterators which allows them to be treated as a stream. Returned by from_iter.

ParseError

Struct which hold information about an error that occured at a specific position. Can hold multiple instances of Error if more that one error occured at the position.

SourcePosition

Struct which represents a position in a source file

State

The State<I> struct keeps track of the current position in the stream I

Enums

Consumed

Enum used to indicate if a parser consumed any items of the stream it was given as an input

Error

Enum used to store information about an error that has occured

Info

Enum holding error information As there is implementations of From for T: Positioner, String and &'static str the constructor need not be used directly as calling msg.into() should turn a message into the correct Info variant

Traits

Parser

By implementing the Parser trait a type says that it can be used to parse an input stream into the type Output.

Positioner

Positioner represents the operations needed to update a position given an item from the stream When implementing stream for custom token type this must be implemented for that token to allow the position to be updated

Stream

A stream is a sequence of items that can be extracted one by one

Functions

from_iter

Converts an Iterator into a stream.

Type Aliases

ParseResult

A type alias over the specific Result type used by parsers to indicate wether they were successful or not. O is the type that is output on success I is the specific stream type used in the parser T is the item type of I, this parameter will be removed once type declarations are allowed to have trait bounds