# [−] [src] Crate regex_syntax

This crate provides a robust regular expression parser.

This crate defines two primary types:

- `Ast` is the abstract syntax of a regular expression. An abstract syntax corresponds to a structured representation of the concrete syntax of a regular expression, where the concrete syntax is the pattern string itself (e.g., `foo(bar)+`). Given some abstract syntax, it can be converted back to the original concrete syntax (modulo some details, like whitespace). To a first approximation, the abstract syntax is complex and difficult to analyze.
- `Hir` is the high-level intermediate representation ("HIR" or "high-level IR" for short) of regular expression. It corresponds to an intermediate state of a regular expression that sits between the abstract syntax and the low level compiled opcodes that are eventually responsible for executing a regular expression search. Given some high-level IR, it is not possible to produce the original concrete syntax (although it is possible to produce an equivalent concrete syntax, but it will likely scarcely resemble the original pattern). To a first approximation, the high-level IR is simple and easy to analyze.

These two types come with conversion routines:

- An `ast::parse::Parser` converts concrete syntax (a `&str`) to an `Ast`.
- A `hir::translate::Translator` converts an `Ast` to a `Hir`.

As a convenience, the above two conversion routines are combined into one via the top-level `Parser` type. This `Parser` will first convert your pattern to an `Ast` and then convert the `Ast` to an `Hir`.

# Example

This example shows how to parse a pattern string into its HIR:

    use regex_syntax::Parser;
    use regex_syntax::hir::{self, Hir};

    let hir = Parser::new().parse("a|b").unwrap();
    assert_eq!(hir, Hir::alternation(vec![
        Hir::literal(hir::Literal::Unicode('a')),
        Hir::literal(hir::Literal::Unicode('b')),
    ]));

# Concrete syntax supported

The concrete syntax is documented as part of the public API of the `regex` crate.

# Input safety

A key feature of this library is that it is safe to use with end user facing input. This plays a significant role in the internal implementation. In particular:

1. Parsers provide a `nest_limit` option that permits callers to control how deeply nested a regular expression is allowed to be. This makes it possible to do case analysis over an `Ast` or an `Hir` using recursion without worrying about stack overflow.
2. Since relying on a particular stack size is brittle, this crate goes to great lengths to ensure that all interactions with both the `Ast` and the `Hir` do not use recursion. Namely, they use constant stack space and heap space proportional to the size of the original pattern string (in bytes). This includes the type's corresponding destructors. (One exception to this is literal extraction, but this will eventually get fixed.)

# Error reporting

The `Display` implementations on all `Error` types exposed in this library provide nice human readable errors that are suitable for showing to end users in a monospace font.

# Literal extraction

This crate provides limited support for literal extraction from `Hir` values. Be warned that literal extraction currently uses recursion, and therefore, stack size proportional to the size of the `Hir`.

The purpose of literal extraction is to speed up searches. That is, if you know a regular expression must match a prefix or suffix literal, then it is often quicker to search for instances of that literal, and then confirm or deny the match using the full regular expression engine. These optimizations are done automatically in the `regex` crate.

## Modules

ast | Defines an abstract syntax for regular expressions.
hir | Defines a high-level intermediate representation for regular expressions.

## Structs

Parser | A convenience parser for regular expressions.
ParserBuilder | A builder for a regular expression parser.

## Enums

Error | This error type encompasses any error that can be returned by this crate.

## Functions

escape | Escapes all regular expression meta characters in `text`.
escape_into | Escapes all meta characters in `text` and writes the result into `buf`.
is_meta_character | Returns true if the give character has significance in a regex.
is_word_byte | Returns true if and only if the given character is an ASCII word character.
is_word_character | Returns true if and only if the given character is a Unicode word character.

## Type Definitions

Result | A type alias for dealing with errors returned by this crate.

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)