# regex.zig

> A Blazing-Fast, Native Regular Expression Engine for Zig

Pure Zig 0.17.0 regex engine with PikeVM non-backtracking NFA, submatch captures, streaming iteration, and ReDoS immunity.

## Table of Contents

### Guide

- [Introduction](/regex.zig/guide/introduction.md): Overview of architecture principles, linear-time guarantees, and capabilities of the pure Zig regex engine.
- [Installation](/regex.zig/guide/installation.md): Add regex.zig to your project using zig fetch, package manifests, local paths, or build system imports.
- [Quick Start](/regex.zig/guide/getting-started.md): Essential regex.zig workflows for compiling patterns, checking matches, extracting captures, and string transformations.
- [Architecture & PikeVM](/regex.zig/guide/architecture.md): Understand the internal matching pipeline, compact instruction set, and lockstep dual-queue thread execution model.
- [Regex Dialect & Syntax](/regex.zig/guide/syntax.md): Syntax guide covering bracket expressions, predefined shorthands, greedy/lazy quantifiers, assertions, and group captures.
- [Inline Options & Limits](/regex.zig/guide/options.md): Overview of anonymous struct literal configurations, compilation flags, execution parameters, and memory safety limits.
- [Cross-Platform Targets](/regex.zig/guide/targets.md): Compilation matrix and portability design principles across 32-bit and 64-bit architectures on Windows, Linux, and macOS.
- [Benchmarks & Performance](/regex.zig/guide/benchmarks.md): Empirically measured throughput, nanosecond latency, SIMD bandwidth, and linear-time ReDoS immunity metrics.

### API Reference

- [Regex API](/regex.zig/api/regex.md): Comprehensive specifications for compile, isMatch, find, findAll, captures, replace, split, and streaming iterators.
- [Options & Limits API](/regex.zig/api/options.md): Type declarations and default parameter values for CompileOptions, MatchOptions, Limits, and iteration settings.
- [Errors & Diagnostics](/regex.zig/api/errors.md): Error set definitions, structured syntax diagnostic fields, and error category classifications for debugging regexes.

### Examples

- [Runnable Examples](/regex.zig/examples.md): Eleven self-contained runnable Zig programs covering basic matching, captures, replacements, Unicode, and safety limits.