Regular Expression Pocket Reference, 2nd Edition

Name

String

Description

String objects contain built-in methods for regular expression pattern matching and substitution, as well as several methods for string manipulation that take regular expressions as arguments.

Instance Methods

string=~regexp=> fixnum or nil

Match the regexp, and return the position that the match starts, or nil.

regexp===string=> boolean

Return true if the regexp matches the string. Used in case-when statements.

gsub(pattern,replacement) => new_stringgsub(pattern) {|match| block } => new_string

Return a copy of string with all occurrences of pattern replaced with replacement, or the value of the block. Otherwise, behaves as Regexp#sub.

gsub!(pattern, replacement) => string or nilgsub!(pattern) {|match| block } => string or nil

Perform the substitutions of String#gsub in place, returning string or returning nil if no substitutions were performed.

index(regexp[,offset]) => fixnum or nil

Return the index of the first match by regexp or nil if not found. Optionally, offset specifies the position in the string to begin the search.

match(pattern) => matchdata or nil

Apply a regex pattern or Regexp object to the string, returning a MatchData object, or returning nil if there was no match.

rindex(regexp[, fixnum]) => fixnum or nil

Return the index of the first match by regexp or nil if not found. Optionally, offset specifies the position in the string to end the search; characters to the right of this point will not be considered.

scan(regexp) => arrayscan(regexp) {|match, ...| block ...