summaryrefslogtreecommitdiff
path: root/doc/strscan/methods/terminate.md
blob: b03b37d2a289abde37349a3629925f4f72d5e820 (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
call-seq:
  terminate -> self

Sets the scanner to end-of-string;
returns +self+:

- Sets both [positions][11] to end-of-stream.
- Clears [match values][9].

```rb
scanner = StringScanner.new(HIRAGANA_TEXT)
scanner.string                 # => "こんにちは"
scanner.scan_until(/に/)
put_situation(scanner)
# Situation:
#   pos:       9
#   charpos:   3
#   rest:      "ちは"
#   rest_size: 6
match_values_cleared?(scanner) # => false

scanner.terminate              # => #<StringScanner fin>
put_situation(scanner)
# Situation:
#   pos:       15
#   charpos:   5
#   rest:      ""
#   rest_size: 0
match_values_cleared?(scanner) # => true
```