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
• any_slice
• 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()
• repeats()
• map()
• peek()
• not()
• input()
• and_then()
• optional()
• label()

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 approach to error handling: Builtin parsers report errors by appendding to a Failurelog. If the top level parser fails, the result will contain an instance of this structure.

Examples

Checkout the integration test directory for concrete parsing examples.

Structs

• AndThen
  See and_then()
• FailureLog
  A log of parser failures sorted by input position in descending order.
• Fold
  See fold()
• Map
  See map().
• Optional
  See optional()
• Or
  See or()
• ParserContext
  Container for input into parsers
• ParserFailure
  A parsing error
• Peek
  See peek()
• Predicate
  See when()
• Utf8Str
  See utf8_str

Enums

• Reason
  The reason parsing failed

Traits

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

Functions

• any_slice
  A parser that recognizes the first item in a slice.
• any_utf8_str
  A parser that recognizes the first unicode scalar value at the start of a string slice.
• 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

• AccumulateInit
  A Fold init function that uses a Vec as an accumulator
• AccumulateOperation
  A Fold operation function that uses a Vec as an accumulator
• RepeatsInit
  A Fold init function that does not use an accumulator.
• RepeatsOperation
  A Fold operation function that does nothing with what is given to it
• Res
  The return value of this crate’s parsers