enum

Regex::Options

Inherits Enum / Comparable / Value / Object

Represents compile options passed to Regex.new.

This type is intended to be renamed to CompileOptions. Please use that name.

Constants

IGNORE_CASE = 1_u64

Case insensitive match.

MULTILINE = 6_u64

Multiline matching.

Equivalent to MULTILINE | DOTALL in PCRE and PCRE2.

MULTILINE_ONLY = 4_u64

Equivalent to MULTILINE in PCRE and PCRE2.

DOTALL = 2_u64

EXTENDED = 8_u64

Ignore white space and # comments.

ANCHORED = 16_u64

Force pattern anchoring at the start of the subject.

DOLLAR_ENDONLY = 32_u64

FIRSTLINE = 262144_u64

ENDANCHORED = 2147483648_u64

Force pattern anchoring at the end of the subject.

Unsupported with PCRE.

NO_UTF_CHECK = 8192_u64

Do not check the pattern for valid UTF encoding.

This option is potentially dangerous and must only be used when the pattern is guaranteed to be valid (e.g. String#valid_encoding?). Failing to do so can lead to undefined behaviour in the regex library and may crash the entire process.

NOTE: String is supposed to be valid UTF-8, but this is not guaranteed or enforced. Especially data originating from external sources should not be trusted.

UTF validation is comparatively expensive, so skipping it can produce a significant performance improvement.

pattern = "fo+"
if pattern.valid_encoding?
  regex = Regex.new(pattern, options: Regex::CompileOptions::NO_UTF_CHECK)
  regex.match(foo)
else
  raise "Invalid UTF in regex pattern"
end

The standard library implicitly applies this option when it can be sure about the patterns's validity (e.g. on repeated matches in String#gsub).

MATCH_INVALID_UTF = 4294967296_u64

Enable matching against subjects containing invalid UTF bytes. Invalid bytes never match anything. The entire subject string is effectively split into segments of valid UTF.