# Ferroni

> Oniguruma-compatible regex engine

## Docs

- [1:1 Parity Goal with C Original](https://ferroni.dev/adr/001-one-to-one-parity-with-c-original)
- [Unsafe Code Policy](https://ferroni.dev/adr/002-unsafe-code-policy)
- [Encoding Scope — ASCII and UTF-8 Only](https://ferroni.dev/adr/003-encoding-scope-ascii-and-utf8-only)
- [C-to-Rust Translation Patterns](https://ferroni.dev/adr/004-c-to-rust-translation-patterns)
- [Idiomatic Rust API Layer](https://ferroni.dev/adr/005-idiomatic-rust-api-layer)
- [Scanner API for Multi-Pattern TextMate Tokenization](https://ferroni.dev/adr/006-scanner-api)
- [SIMD-Accelerated Search via memchr](https://ferroni.dev/adr/007-simd-accelerated-search)
- [Rust-Only Optimizations and Performance Philosophy](https://ferroni.dev/adr/008-rust-only-optimizations)
- [Dependency Philosophy](https://ferroni.dev/adr/009-dependency-philosophy)
- [Benchmark Strategy](https://ferroni.dev/adr/010-benchmark-strategy)
- [Test Strategy and C Test Suite Parity](https://ferroni.dev/adr/011-test-strategy-and-c-test-parity)
- [POSIX and GNU API Not Ported](https://ferroni.dev/adr/012-posix-and-gnu-api-not-ported)
- [Stack Overflow in Debug Builds During Full Test Suite](https://ferroni.dev/adr/013-stack-overflow-debug-builds)
- [Porting Bugs -- Lessons Learned](https://ferroni.dev/adr/014-porting-bugs-lessons-learned)
- [Generate Unicode Tables from the UCD](https://ferroni.dev/adr/015-unicode-data-from-ucd)
- [Compilation and Search-Time Tradeoffs](https://ferroni.dev/adr/016-compilation-and-search-tradeoffs)
- [Limit Outcomes Relative to C](https://ferroni.dev/adr/017-limit-outcomes-relative-to-c)
- [Coming from regex or onig](https://ferroni.dev/guide/coming-from-regex)
- [Compatibility](https://ferroni.dev/guide/compatibility)
- [Getting Started](https://ferroni.dev/guide/getting-started)
- [Migrating to 2.0](https://ferroni.dev/guide/migrating-to-2)
- [Untrusted Input](https://ferroni.dev/guide/untrusted-input)
- [Regex Benchmarks](https://ferroni.dev/perf/regex-workloads)

## More

- [Full documentation](https://ferroni.dev/llms-full.txt): Complete documentation as one Markdown file.