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