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

instance method

StringScanner#pos

() -> ::Integer

pos → byte_position

static VALUE
strscan_get_pos(VALUE self)
{
    struct strscanner *p;

    GET_SCANNER(self, p);
    return LEN2NUM(p->curr);
}

Returns the integer byte position, which may be different from the character position:

Example

scanner = StringScanner.new(HIRAGANA_TEXT)
scanner.string  # => "こんにちは"
scanner.pos     # => 0
scanner.getch   # => "こ" # 3-byte character.
scanner.charpos # => 1
scanner.pos     # => 3

See also #pos= #pointer= #pointer #post_match also in 4.0 · 3.4 · 3.3 · 3.2 · 3.1 · 3.0

‹ prev#pointer= next ›#pos=