summaryrefslogtreecommitdiff
path: root/doc/strscan/methods/skip.md
blob: 10a329e0e42f9357bab68443d38bdbfddd32427a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
call-seq:
  skip(pattern) match_size or nil

Attempts to [match][17] the given `pattern`
at the beginning of the [target substring][3];

If the match succeeds:

- Increments the [byte position][2] by substring.bytesize,
  and may increment the [character position][7].
- Sets [match values][9].
- Returns the size (bytes) of the matched substring.

```rb
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
```