summaryrefslogtreecommitdiff
path: root/doc/string/scan.rdoc
blob: 04a2b02ff4ec1bcc0d2c5d501e23b520d921348a (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
31
32
33
34
35
Matches a pattern against +self+:

- If +pattern+ is a Regexp, the pattern used is +pattern+ itself.
- If +pattern+ is a string, the pattern used is <tt>Regexp.quote(pattern)</tt>.

Generates a collection of matching results
and updates {regexp-related global variables}[rdoc-ref:Regexp@Global+Variables]:

- If the pattern contains no groups, each result is a matched substring.
- If the pattern contains groups, each result is an array
  containing a matched substring for each group.

With no block given, returns an array of the results:

  'cruel world'.scan(/\w+/)      # => ["cruel", "world"]
  'cruel world'.scan(/.../)      # => ["cru", "el ", "wor"]
  'cruel world'.scan(/(...)/)    # => [["cru"], ["el "], ["wor"]]
  'cruel world'.scan(/(..)(..)/) # => [["cr", "ue"], ["l ", "wo"]]
  'こんにちは'.scan(/../)         # => ["こん", "にち"]
  'abracadabra'.scan('ab')       # => ["ab", "ab"]
  'abracadabra'.scan('nosuch')   # => []

With a block given, calls the block with each result; returns +self+:

  'cruel world'.scan(/\w+/) {|w| p w }
  # => "cruel"
  # => "world"
  'cruel world'.scan(/(.)(.)/) {|x, y| p [x, y] }
  # => ["c", "r"]
  # => ["u", "e"]
  # => ["l", " "]
  # => ["w", "o"]
  # => ["r", "l"]

Related: see {Converting to Non-String}[rdoc-ref:String@Converting+to+Non--5CString].