summaryrefslogtreecommitdiff
path: root/doc/strscan/methods/terminate.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/strscan/methods/terminate.md')
-rw-r--r--doc/strscan/methods/terminate.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/strscan/methods/terminate.md b/doc/strscan/methods/terminate.md
new file mode 100644
index 0000000000..27f7d41cb1
--- /dev/null
+++ b/doc/strscan/methods/terminate.md
@@ -0,0 +1,27 @@
+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
+```