Crate parser_compose

See the README.md for a crash course in parser combinators.

The crate is logically organized into three parts

Parsers

Any rust item that implements the Parser trait can parse input by calling try_parse()

• &str
• slices
• utf8_str
• any_utf8_str
• byte
• any_byte
• end

Additionally the Parser trait is implemented for all function with a particular signature.

Parser combinators

The associated methods on the Parser trait are used to combine with other parsers.

• or()
• when()
• fold()
• accumulate()
• skim()
• map()
• peek()
• not()
• input()
• and_then()
• optional()

The sequence combinator is so common that it has a special form. Tuples of parsers implement Parser such that the tuple parser succeeds if all its parsers succeed.

Errors

parser-compose take a simple but comprehensive approach to error handling: All parsers and combinators report errors by building up an ErrorTree. If the top level parser fails, the result will contain an instance of this tree.

Examples

Checkout the integration test directory for concrete parsing examples.

Structs

• AndThen
  See and_then()
• Byte
  See byte
• Fold
  See fold()
• Map
  See map().
• Optional
  See optional()
• Or
  See or()
• ParserContext
  Container for input into parsers
• Peek
  See peek()
• Predicate
  See when()
• Utf8Str
  See utf8_str

Enums

• ErrorTree
  The error type returned when parsers fail.

Traits

• Parser
  A trait for parsers
• RepetitionArgument
  Trait used to specify how many times a parser should run.

Functions

• any_byte
  A parser that recognizes the first byte in a byte slice.
• any_utf8_str
  A parser that recognizes the first unicode scalar value at the start of a string slice.
• byte
  Returns a parser that recognizes the first byte in a byte slice if its value is in the specified range
• end
  A parser that succeeds if there is no more input to consume.
• utf8_str
  Returns a parser that recognizes the first unicode scalar value in a string slice if its value is in the specified range

Type Aliases

• Res
  The return value of this crate’s parsers