class

Regex

@Serializable { simple=true }
const class Regex : Obj

Regex represents a regular expression.

 constructors fromStr

Compile a regular expression pattern string

 fields defVal

Default value is Regex("")

 methods toStr

Return the regular expression pattern string

 quote

Make a Regex that matches the given string exactly

 split

Split the specified string around matches of this pattern

 equals

Equality is based on pattern string and flags

 flags

Return flags string

 glob

Make a Regex which will match a glob pattern

 matcher

Return a RegexMatcher instance to use for matching operations against the specified string

 matches

Convenience for matcher(s).matches

 hash

Return toStr.hash

 defVal const static Regex : defVal

Default value is Regex("").

 equals virtual Bool equals(Obj? obj)

Equality is based on pattern string and flags.

 flags Str flags()

Return flags string

 fromStr static new fromStr(Str pattern, Str flags)

Compile a regular expression pattern string. Flags is a string of ASCII chars. In JavaScript the flags are passed directly to RegExp. In Java the flags are matched against known constants or ignored. The following cross-platform flags are supported:

  • i: case insensitive
  • m: multi-line support for start/end matching
  • s: dot all to allow "." to match newlines

 glob static Regex glob(Str pattern)

Make a Regex which will match a glob pattern:

  • "?": match one unknown char (maps to "." in regex)
  • "*": match zero or more unknown char (maps to ".*" in regex)
  • any other character is matched exactly

 hash virtual Int hash()

Return toStr.hash.

 matcher RegexMatcher matcher(Str s)

Return a RegexMatcher instance to use for matching operations against the specified string.

 matches Bool matches(Str s)

Convenience for matcher(s).matches.

 quote static Regex quote(Str str)

Make a Regex that matches the given string exactly. All non-alpha numeric characters are escaped.

 split Str[] split(Str s, Int limit)

Split the specified string around matches of this pattern. The limit parameter specifies how many times to apply the pattern:

  • If limit is greater than zero, the pattern is applied at most limit-1 times and any remaining input will be returned as the list's last item.
  • If limit is less than zero, then the pattern is matched as many times as possible.
  • If limit is zero, then the pattern is matched as many times as possible, but trailing empty strings are discarded.

 toStr virtual Str toStr()

Return the regular expression pattern string.

 Haxall 4.0.5 ∙ 24-Feb-2026 14:33 EST