instance method

StringScanner#charpos

() -> ::Integer

charpos

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

    GET_SCANNER(self, p);

    return LONG2NUM(rb_enc_strlen(S_PBEG(p), CURPTR(p), rb_enc_get(p->str)));
}

call-seq: charpos -> character_position

Returns the character position (initially zero), which may be different from the byte position given by method pos:

Example

scanner = StringScanner.new(HIRAGANA_TEXT)
scanner.string # => "こんにちは"
scanner.getch  # => "こ" # 3-byte character.
scanner.getch  # => "ん" # 3-byte character.
put_situation(scanner)
# Situation:
#   pos:       6
#   charpos:   2
#   rest:      "にちは"
#   rest_size: 9

See also #captures #check #beginning_of_line? #check_until also in 4.1 · 3.4 · 3.3 · 3.2 · 3.1 · 3.0

‹ prev#captures next ›#check