regexp

A regular expression library based on a backtracking engine.

regexp

regular

expression

Download zip

Author

yj-qin

Version

0.3.5

License

Apache-2.0

Repository

github.com/yj-qin/regexp

Last updated

last year

Downloads

No dependencies

#RegExp

A regular expression module based on a backtracking engine. Due to backtracking during matching, some regular expressions will run for a long time under specific inputs, also known as catastrophic backtracking. The design of the bytecode and interpreter was heavily inspired by the .NET regular expression library.

#Usage

test "basic" {
  let regexp = @regexp.compile!(
    "^(?<addr>[a-zA-Z0-9._%+-]+)@(?<host>[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,})$",
  )
  let match_result = regexp.matches("12345@test.com")
  @json.inspect!(match_result.success(), content=true)
  @json.inspect!(match_result.captures(), content=[
    "12345@test.com", "12345", "test.com",
  ])
  @json.inspect!(match_result.named_captures(), content={
    "addr": "12345",
    "host": "test.com",
  })
}

#Features

#Character classes

Character range
Escapes (e.g. \d, \D, \s, \S, \w, \W)

#Assertions

Begin of input
End of input
Word boundary
Lookaround

#Groups

Capturing group
Non-capturing group
Named capturing group

#Backreferences

Group backreference
Named backreference

#Quantifiers

#Encodings

Unicode

MatchResult

source

type MatchResult

impl Show for MatchResult

MatchResult::captures

source

fn MatchResult::captures(self : MatchResult) -> Array[String]

MatchResult::named_captures

source

fn MatchResult::named_captures(self : MatchResult) -> Map[String, String]

MatchResult::success

source

fn MatchResult::success(self : MatchResult) -> Bool

ParseError

source

pub(all) enum ParseError {
  InternalParserError
  UnmatchedGroupBegin(Int)
  UnmatchedGroupEnd(Int)
  UnmatchedGroupName(Int)
  EmptyGroupName(Int)
  EmptyGroup(Int)
  UnmatchedCharClassEnd(Int)
  UnspecifiedLoopTarget(Int)
  InvalidLoop(Int)
  LoopCountOutOfRange(Int)
  LoopMaxCountSmallerThanMinCount(Int)
  EndPatternAtEscape(Int)
  ClassMissingBracket(Int)
  GroupMissingParen(Int)
}

impl Eq for ParseError

impl Show for ParseError

RegExp

source

type RegExp

RegExp::matches

source

fn RegExp::matches(self : RegExp, text : String, start~ : Int = .., end~ : Int = ..) -> MatchResult

RegExp::pattern

source

fn RegExp::pattern(self : RegExp) -> String

captures

source

fn captures(self : MatchResult) -> Array[String]

compile

source

fn compile(pattern : String) -> RegExp!Error

matches

source

fn matches(self : RegExp, text : String, start~ : Int = .., end~ : Int = ..) -> MatchResult

named_captures

source

fn named_captures(self : MatchResult) -> Map[String, String]

pattern

source

fn pattern(self : RegExp) -> String

success

source

fn success(self : MatchResult) -> Bool

regexp

#RegExp

#Usage

#Features

#Character classes

#Assertions

#Groups

#Backreferences

#Quantifiers

#Encodings

#MatchResult

#MatchResult::captures

#MatchResult::named_captures

#MatchResult::success

#ParseError

#RegExp

#RegExp::matches

#RegExp::pattern

#captures

#compile

#matches

#named_captures

#pattern

#success

Source Files

MatchResult

MatchResult::captures

MatchResult::named_captures

MatchResult::success

ParseError

RegExp

RegExp::matches

RegExp::pattern

captures

compile

matches

named_captures

pattern

success