Document-class: Regexp
A Regexp holds a regular expression, used to match a pattern against strings. Regexps are created using the /…/ and %r{…} literals, and by the Regexp::new constructor.
| Constants | |
|---|---|
| EXTENDED | |
| IGNORECASE | |
| MULTILINE | |
| Public Methods | |
|---|---|
| == | Equality—Two regexps are equal if their patterns are identical, they have the same character set code, and their casefold? values are the same. |
| === | Case Equality—Synonym for Regexp#=~ used in case statements. |
| =~ | Returns a MatchData object describing the match, or nil if there was no match. This is equivalent to retrieving the value of the special variable $~ following a normal match. |
| casefold? | Returns the value of the case-insensitive flag. |
| compile | Synonym for Regexp.new |
| eql? | Equality—Two regexps are equal if their patterns are identical, they have the same character set code, and their casefold? values are the same. |
| escape | Escapes any characters that would have special meaning in a regular expression. Returns a new escaped string, or self if no characters are escaped. For any string, Regexp.escape(str)=~str will be true. |
| hash | Produce a hash based on the text and options of this regular expression. |
| inspect | Produce a nicely formatted string-version of rxp. Perhaps surprisingly, #inspect actually produces the more natural version of the string than #to_s. |
| kcode | Returns the character set code for the regexp. |
| last_ |
The first form returns the MatchData object generated by the last successful pattern match. Equivalent to reading the global variable $~. The second form returns the nth field in this MatchData object. |
| match | Returns a MatchData object describing the match, or nil if there was no match. This is equivalent to retrieving the value of the special variable $~ following a normal match. |
| new | Constructs a new regular expression from pattern, which can be either a String or a Regexp (in which case that regexp’s options are propagated, and new options may not be specified (a change as of Ruby 1.8). If options is a Fixnum, it should be one or more of the constants Regexp::EXTENDED, Regexp::IGNORECASE, and Regexp::MULTILINE, or-ed together. Otherwise, if options is not nil, the regexp will be case insensitive. The lang parameter enables multibyte support for the regexp: `n’, `N’ = none, `e’, `E’ = EUC, `s’, `S’ = SJIS, `u’, `U’ = UTF-8. |
| options | Returns the set of bits corresponding to the options used when creating this Regexp (see Regexp::new for details. Note that additional bits may be set in the returned options: these are used internally by the regular expression code. These extra bits are ignored if the options are passed to Regexp::new. |
| quote | Escapes any characters that would have special meaning in a regular expression. Returns a new escaped string, or self if no characters are escaped. For any string, Regexp.escape(str)=~str will be true. |
| source | Returns the original string of the pattern. |
| to_ |
Returns a string containing the regular expression and its options (using the (?xxx:yyy) notation. This string can be fed back in to Regexp::new to a regular expression with the same semantics as the original. (However, Regexp#== may not return true when comparing the two, as the source of the regular expression itself may differ, as the example shows). Regexp#inspect produces a generally more readable version of rxp. |
| union | Return a Regexp object that is the union of the given patterns, i.e., will match any of its parts. The patterns can be Regexp objects, in which case their options will be preserved, or Strings. If no arguments are given, returns /(?!)/. |
| ~ | Match—Matches rxp against the contents of $_. Equivalent to rxp =~ $_. |
<code/>and<pre/>for code samples.