Preview Ruby 4.1 is a preview. It can change before the final release. Switch to Ruby 4.0 →
instance method
MatchData#offset
(::MatchData::capture backref) -> ([ ::Integer, ::Integer ] | [ nil, nil ])
offset(n) → [start_offset, end_offset]
offset(name) → [start_offset, end_offset]
re.c
View on GitHub ↗
static VALUE
match_offset(VALUE match, VALUE n)
{
int i = match_backref_number(match, n);
match_check(match);
backref_number_check(match, i);
if (RMATCH_BEG(match, i) < 0)
return rb_assoc_new(Qnil, Qnil);
update_char_offset(match);
return rb_assoc_new(LEN2NUM(RMATCH(match)->char_offset[i].beg),
LEN2NUM(RMATCH(match)->char_offset[i].end));
}
Returns a 2-element array containing the beginning and ending offsets (in characters) of the specified match.
When non-negative integer argument n is given, returns the starting and ending offsets of the nth match:
Example
m = /(.)(.)(\d+)(\d)/.match("THX1138.") # => #<MatchData "HX1138" 1:"H" 2:"X" 3:"113" 4:"8"> m[0] # => "HX1138" m.offset(0) # => [1, 7] m[3] # => "113" m.offset(3) # => [3, 6] m = /(ん)(に)(ち)/.match('こんにちは') # => #<MatchData "んにち" 1:"ん" 2:"に" 3:"ち"> m[0] # => "んにち" m.offset(0) # => [1, 4] m[3] # => "ち" m.offset(3) # => [3, 4]
When string or symbol argument name is given, returns the starting and ending offsets for the named match:
Example
m = /(?<foo>.)(.)(?<bar>.)/.match("hoge") # => #<MatchData "hog" foo:"h" bar:"g"> m[:foo] # => "h" m.offset('foo') # => [0, 1] m[:bar] # => "g" m.offset(:bar) # => [2, 3]
Related: MatchData#byteoffset, MatchData#begin, MatchData#end.