Preview Ruby 4.1 is a preview. It can change before the final release. Switch to Ruby 4.0 →

instance method · added in Ruby 3.4

MatchData#bytebegin

(::MatchData::capture backref) -> ::Integer?

bytebegin(n) → integer

bytebegin(name) → integer

static VALUE
match_bytebegin(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;
    return LEN2NUM(RMATCH_BEG(match, i));
}

Returns the offset (in bytes) 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.bytebegin(0) # => 1
m[3]       # => "113"
m.bytebegin(3) # => 3

m = /(ん)(に)(ち)/.match('こんにちは')
# => #<MatchData "んにち" 1:"ん" 2:"に" 3:"ち">
m[0]           # => "んにち"
m.bytebegin(0) # => 3
m[3]           # => "ち"
m.bytebegin(3) # => 9

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.bytebegin('foo') # => 0
m[:bar]        # => "g"
m.bytebegin(:bar)  # => 2

Ruby version changes

3.4
- MatchData#bytebegin and MatchData#byteend have been added. [Feature #20576]

See also #begin #byteend #[] #byteoffset also in 4.0 · 3.4

‹ prev#begin next ›#byteend