summaryrefslogtreecommitdiff
path: root/doc/strscan/methods/set_pos.md
blob: 3b7abe65e3379aee66019726cd543144b131bea2 (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
call-seq:
  pos = n -> n
  pointer = n -> n

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