instance method

StringScanner#get_byte

() -> ::String?

get_byte

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

    GET_SCANNER(self, p);
    CLEAR_MATCH_STATUS(p);
    if (EOS_P(p))
        return Qnil;

    p->prev = p->curr;
    p->curr++;
    MATCHED(p);
    adjust_registers_to_matched(p);
    return extract_range(p,
                         adjust_register_position(p, p->regs.beg[0]),
                         adjust_register_position(p, p->regs.end[0]));
}

call-seq: get_byte -> byte_as_character or nil

Returns the next byte, if available:

If the position is not at the end of the stored string:

Returns the next byte.
Increments the byte position.
Adjusts the character position.

Example

scanner = StringScanner.new(HIRAGANA_TEXT)
# => #<StringScanner 0/15 @ "\xE3\x81\x93\xE3\x82...">
scanner.string                                   # => "こんにちは"
[scanner.get_byte, scanner.pos, scanner.charpos] # => ["\xE3", 1, 1]
[scanner.get_byte, scanner.pos, scanner.charpos] # => ["\x81", 2, 2]
[scanner.get_byte, scanner.pos, scanner.charpos] # => ["\x93", 3, 1]
[scanner.get_byte, scanner.pos, scanner.charpos] # => ["\xE3", 4, 2]
[scanner.get_byte, scanner.pos, scanner.charpos] # => ["\x82", 5, 3]
[scanner.get_byte, scanner.pos, scanner.charpos] # => ["\x93", 6, 2]

Otherwise, returns nil, and does not change the positions.

Example

scanner.terminate
[scanner.get_byte, scanner.pos, scanner.charpos] # => [nil, 15, 5]

See also #fixed_anchor? #getch #exist? #initialize_copy also in 4.1 · 3.4 · 3.3 · 3.2 · 3.1 · 3.0

‹ prev#fixed_anchor? next ›#getch