diff options
Diffstat (limited to 'doc/strscan/methods/set_pos.md')
| -rw-r--r-- | doc/strscan/methods/set_pos.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/strscan/methods/set_pos.md b/doc/strscan/methods/set_pos.md new file mode 100644 index 0000000000..6a43edeb41 --- /dev/null +++ b/doc/strscan/methods/set_pos.md @@ -0,0 +1,23 @@ +Sets the [byte position][2] and the [character position][11]; +returns `n`. + +Does not affect [match values][9]. + +For non-negative `n`, sets the position to `n`: + +```rb +scanner = StringScanner.new(HIRAGANA_TEXT) +scanner.string # => "こんにちは" +scanner.pos = 3 # => 3 +scanner.rest # => "んにちは" +scanner.charpos # => 1 +``` + +For negative `n`, counts from the end of the [stored string][1]: + +```rb +scanner.pos = -9 # => -9 +scanner.pos # => 6 +scanner.rest # => "にちは" +scanner.charpos # => 2 +``` |
