summaryrefslogtreecommitdiff
path: root/doc/strscan/methods/get_pos.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/strscan/methods/get_pos.md')
-rw-r--r--doc/strscan/methods/get_pos.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/strscan/methods/get_pos.md b/doc/strscan/methods/get_pos.md
new file mode 100644
index 0000000000..56b1636812
--- /dev/null
+++ b/doc/strscan/methods/get_pos.md
@@ -0,0 +1,11 @@
+Returns the integer [byte position][2],
+which may be different from the [character position][7]:
+
+```rb
+scanner = StringScanner.new(HIRAGANA_TEXT)
+scanner.string # => "こんにちは"
+scanner.pos # => 0
+scanner.getch # => "こ" # 3-byte character.
+scanner.charpos # => 1
+scanner.pos # => 3
+```