instance method

StringScanner#skip_until

(::Regexp) -> ::Integer?

skip_until(p1)

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

call-seq: skip_until(pattern) -> matched_substring_size or nil

Attempts to match the given pattern anywhere (at any position) in the target substring; does not modify the positions.

If the match attempt succeeds:

Sets match values.
Returns the size of the matched substring.

Example

scanner = StringScanner.new(HIRAGANA_TEXT)
scanner.string           # => "こんにちは"
scanner.pos = 6
scanner.skip_until(/ち/) # => 6
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:       12
#   charpos:   4
#   rest:      "は"
#   rest_size: 3

If the match attempt fails:

Clears match values.
Returns nil.

Example

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

See also #skip #string #size #string= also in 4.1 · 3.4 · 3.3 · 3.2 · 3.1 · 3.0

‹ prev#skip next ›#string