[][src]Crate pest

pest. The Elegant Parser

pest is a general purpose parser written in Rust with a focus on accessibility, correctness, and performance. It uses parsing expression grammars (or PEG) as input, which are similar in spirit to regular expressions, but which offer the enhanced expressivity needed to parse complex languages.

Getting started

The recommended way to start parsing with pest is to read the official book.

Other helpful resources:

  • API reference on docs.rs
  • play with grammars and share them on our fiddle
  • leave feedback, ask questions, or greet us on Gitter

Usage

The core of pest is the trait Parser, which provides an interface to the parsing functionality.

The accompanying crate pest_derive can automatically generate a Parser from a PEG grammar. Using pest_derive is highly encouraged, but it is also possible to implement Parser manually if required.

.pest files

Grammar definitions reside in custom .pest files located in the crate src directory. Parsers are automatically generated from these files using #[derive(Parser)] and a special #[grammar = "..."] attribute on a dummy struct.

This example is not tested
#[derive(Parser)]
#[grammar = "path/to/my_grammar.pest"] // relative to src
struct MyParser;

The syntax of .pest files is documented in the pest_derive crate.

Modules

error

Types for different kinds of parsing failures.

iterators

Types and iterators for parser output.

prec_climber

Constructs useful in infix operator parsing with the precedence climbing method.

Macros

fails_with

Testing tool that compares produced errors.

parses_to

Testing tool that compares produced tokens.

Structs

ParserState

The complete state of a Parser.

Position

A cursor position in a &str which provides useful methods to manually parse that string.

Span

A span over a &str. It is created from either two Positions or from a Pair.

Enums

Atomicity

The current atomicity of a ParserState.

Lookahead

The current lookahead status of a ParserState.

Token

A token generated by a Parser.

Traits

Parser

A trait with a single method that parses strings.

RuleType

A trait which parser rules must implement.

Functions

state

Creates a ParserState from a &str, supplying it to a closure f.

Type Definitions

ParseResult

Type alias to simplify specifying the return value of chained closures.