Crate shrimple_parser

source ·
Expand description

Zero-dependency library for writing parsers in a concise functional style & with exhaustive error-reporting.

Kinds of errors are distinguished via a user-defined Reason type, which signals what did a parser expect. A ParsingError can also have no reason, which will mean that the error is recoverable. Some built-in parsers can have std::convert::Infallible as their error reason, which means that any error the parser may ever return is recoverable. The distinction between recoverable & fatal errors is important for parsers that need to try multiple options.

Error reporting with precise location in the source is facilitated by constructing a FullParsingError with methods such as Parser::with_full_error, ParsingError::with_src_loc

Modules§

  • tuple
    This module contains utilities for working with generic tuples, such as:
  • utils
    This module provides utility functions for locating pointers into text.

Macros§

  • call
    Generates a closure that calls a function with a tuple’s contents as it arguments. The input can be anything as long as the last token contains all the arguments parenthesized.
  • from_tuple
    Generates a closure that constructs a struct from a tuple. The struct fields must be exactly in the order in which they’re expected to be in the tuple.
  • nonzero
    Create a non-zero integer from a literal.

Structs§

Traits§

  • Parser
    The core of the crate, a trait representing a function that takes some string as input and returns either a tuple of (the rest of the input, the output) or a ParsingError.

Functions§

  • parse_any_char
    Parses any 1 character from the input. See also parse_char
  • parse_char
    Parses exactly 1 character ch from the input. See also parse_any_char
  • parse_exact
    Parses exactly 1 string prefix from the input.
  • parse_group
    Parse a balanced group of open & close characters.
  • parse_until
    Strips characters from the input until pred returns true, i.e. while it returns false, returns the string spanning the stripped characters.
  • parse_until_ex
    Like parse_until, but also removes the character on which pred returned true from the rest of the input.
  • parse_until_exact
    Strips characters from the input until delimiter is met, returns the string before it. The delimiter is omitted from both the output and the rest of the input.
  • parse_while
    Strips characters from the input until pred returned false, i.e. while it returns true, returns the string spanning the stripped characters.
  • parse_while_ex
    Like parse_while, but also removes the character on which pred returned false from the rest of the input.

Type Aliases§