Skip to main content

Module api

Module api 

Source
Expand description

The idiomatic Rust API. Regex compiles and searches a pattern, RegexBuilder sets its options and syntax, and Match, Captures and FindIter report what a search found. It wraps the C-port functions onig_new and onig_search.

Structs§

CaptureMatches
Iterator over the capture groups of all non-overlapping matches in a text.
CaptureNames
Iterator over the names of the capture groups, from Regex::capture_names.
Captures
All capture groups from a single match.
CapturesIter
Iterator over capture groups in a Captures.
FindIter
Iterator over all non-overlapping matches in a text.
Match
A single match result referencing the original text.
Regex
A compiled regular expression.
RegexBuilder
Builder for compiling a Regex with custom options.
SearchOptions
Limits for a single search.
TryCaptureMatches
Iterator over the capture groups of matches that applies SearchOptions to each search.
TryFindIter
Iterator over matches that applies SearchOptions to each search.

Enums§

Syntax
A built-in regex syntax definition.