instance method

StringScanner#skip

(::Regexp) -> ::Integer?

skip(p1)

static VALUE
strscan_skip(VALUE self, VALUE re)
{
    return strscan_do_scan(self, re, 1, 0, 1);
}

call-seq: skip(pattern) match_size or nil

Attempts to match the given pattern at the beginning of the target substring;

If the match succeeds:

Increments the byte position by substring.bytesize, and may increment the character position.
Sets match values.
Returns the size (bytes) of the matched substring.

Example

scanner = StringScanner.new(HIRAGANA_TEXT)
scanner.string                  # => "こんにちは"
scanner.pos = 6
scanner.skip(/に/)              # => 3
put_match_values(scanner)
# Basic match values:
#   matched?:       true
#   matched_size:   3
#   pre_match:      "こん"
#   matched  :      "に"
#   post_match:     "ちは"
# Captured match values:
#   size:           1
#   captures:       []
#   named_captures: {}
#   values_at:      ["に", nil]
#   []:
#     [0]:          "に"
#     [1]:          nil
put_situation(scanner)
# Situation:
#   pos:       9
#   charpos:   3
#   rest:      "ちは"
#   rest_size: 6

scanner.skip(/nope/)            # => nil
match_values_cleared?(scanner)  # => true

See also #size #skip_until #scan_until #string also in 4.1 · 3.4 · 3.3 · 3.2 · 3.1 · 3.0

‹ prev#size next ›#skip_until